文档中心

负载均衡

API 参考

调用方式

请求结构

若您调用火山引擎 ALB 的 OpenAPI ，是通过向指定服务地址发送请求，并满足火山引擎签名信息和具体接口的业务信息来完成的。火山引擎 ALB 的 API 请求的结构涵盖以下内容：

服务地址。

通讯协议。

请求方法。

请求参数。

字符编码。

服务地址

下表列出了 ALB OpenAPI 的服务接入地址。

地域	地域 ID	服务接入地址
华北2（北京）	cn-beijing	alb.cn-beijing.volcengineapi.com
华东2（上海）	cn-shanghai	alb.cn-shanghai.volcengineapi.com
华南1（广州）	cn-guangzhou	alb.cn-guangzhou.volcengineapi.com
中国香港	cn-hongkong	alb.cn-hongkong.volcengineapi.com
亚太东南（柔佛）	ap-southeast-1	alb.ap-southeast-1.volcengineapi.com
亚太东南（雅加达）	ap-southeast-3	alb.ap-southeast-3.volcengineapi.com

注意

在各个接口的文档中，请求示例中将统一使用 alb.cn-beijing.volcengineapi.com。请您在调用接口时，按照资源实际所属地域替换服务接入地址。

通信协议

必须使用 HTTPS 协议发送请求。

请求方法

请求方法详见各个接口具体的需求。火山引擎 ALB 的 OpenAPI 仅支持 GET 请求。

注意事项

使用 GET 方式时，公共请求参数中的 Action 和 Version 必须放在 Query String 中。

使用 GET 方式时，所有请求参数均需要做 URL 编码。

请求参数

ALB 的 OpenAPI 请求包含两类参数：公共请求参数和接口请求参数。

公共请求参数是每一个接口需要包含的，具体可参见公共参数。

接口请求参数是各个接口特有的，详见各个接口描述。

字符编码

请求及返回结果使用 UTF-8 的字符集进行编码。

公共参数

公共请求参数是每个 API 请求必须包含的参数。如果 API 请求中缺少公共请求参数，请求会失败。

公共请求参数首字母均为大写，以此区分其他请求参数。公共请求参数分为 URI 参数和签名参数。

URI 参数

URI 参数必须包含在 Query String 中。

名称	类型	是否必选	格式	说明	示例
Action	String	是	[a-zA-Z]+	API 名称，与具体的接口相关，表示要执行的操作。	CreateLoadBalancer
Version	String	是	YYYY-MM-DD	API 版本信息。	2020-04-01
X-Expires	Integer	否	900	表示签名的有效时间，单位是秒，默认值是 900。	300

签名参数

每个 API 请求必须包含签名参数。签名参数可以包含在 Query String 中作为 URI 参数，也可以包含在 Request Headers 中。

在 Request Headers 中的场景

如果在 Request Headers 中包含签名参数，必须包含以下参数。

名称	类型	是否必选	描述
X-Date	String	是	表示签名的 UTC 时间，精确到秒。如20201103T104027Z
Authorization	String	是	表示签名值。 HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

Authorization 示例中的信息含义如下：

名称	类型	描述	示例
AccessKey	string	火山引擎账号的 AccessKey ID，可以从秘钥管理页面获取。	AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE
ShortDate	String	请求的时间，使用 UTC 时间，精确到日。	20210913
Region	String	请求的地域。	cn-beijing
Service	String	请求的服务名称。	alb
SignedHeaders	String	参与签名的 Request Headers。Request Headers 之间以分号分隔。	host;x-content-sha256;x-date
Signature	String	计算后的签名。	关于更多签名的信息，参见签名机制。

在 Query String 中包含签名参数

如果在 Query String 中包含签名参数，必须包含以下参数。

名称	类型	是否必选	描述	示例
X-Date	String	是	表示签名的 UTC 时间，精确到秒。	20210913T081805Z
X-Algorithm	String	是	表示签名算法，该参数是一个固定值。	HMAC-SHA256
X-Credential	String	是	{AccessKey}/{ShortDate}/{Region}/{Service}/request 组成。	-
X-SignedHeaders	String	是	参与签名的 Request Headers。Request Headers 之间以分号分隔。	host;x-content-sha256;x-date
X-Signature	String	是	计算后的签名。	关于更多签名的信息，参见签名机制。

签名机制

为了保证请求者身份的合法性以及请求在传输过程中不被恶意篡改，火山引擎签名机制要求请求者对请求参数进行哈希值计算，经过加密后同 API 请求一起发送到服务器中，服务器将以同样的机制对收到的请求进行签名计算，并以此与请求者传来的签名进行比对，若签名未通过验证，请求将被拒绝。更多内容，请您参考签名方法文档。

返回结构

API 请求成功时，HTTP 响应状态码是 200。 API 请求失败时，会出现以下任意一个情况：

HTTP 响应状态码是 4xx 或 5xx。

响应正文的 ResponseMetadata 结构体包含 Error 字段。

API请求成功的响应示例

API 请求失败的响应示例

相较于请求成功的响应结果，请求失败的响应结果不再有Result部分，而ResponseMetadata中将额外出现 Error 字段，字段解释如下：

字段	说明
Error	Error 出现表明本次请求失败。
Code	Code 内容为具体的错误码，您可根据错误码查询文档自助解决问题。
CodeN	CodeN 为标识错误码的数字 ID ，方便查找问题，仅部分接口会提供 CodeN 。
Message	Message描述了错误发生的具体原因，供您排查问题参考。
RequestId	RequestId 是每次 API 请求的唯一标识，当出现了无法自助解决的问题时，您可通过工单系统联系我们，提供请求的 RequestId ，我们将协助进行故障排查。

最近更新时间：2026.10.28 10:15:03

这个页面对您有帮助吗？

有用

无用