You need to enable JavaScript to run this app.
导航

公共请求参数

最近更新时间2022.09.01 11:30:05

首次发布时间2022.09.01 11:30:05

公共请求参数是每个 API 请求必须包含的参数。如果 API 请求中缺少公共请求参数,请求会失败。
公共请求参数首字母均为大写,以此区分其他请求参数。公共请求参数分为 URI 参数和签名参数。

URI 参数

URI 参数必须包含在 query string 中。

名称类型是否必选格式说明示例
Action
string
[a-zA-Z]+
API 名称,与具体的接口相关,表示要执行的操作。
CreateAccelerator
VersionstringYYYY-MM-DDAPI 版本信息。2022-03-01

签名参数

每个 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
ShortDatestring请求的时间,使用 UTC 时间,精确到日。20210913
Regionstring请求的地域。cn-beijing
Servicestring请求的服务名称。ALB
SignedHeadersstring参与签名的 request headers。Request headers 之间以分号分隔。host;x-content-sha256;x-date
Signaturestring计算后的签名。关于更多签名的信息,参见签名机制

在 query string 中包含签名参数

如果在 query string 中包含签名参数,必须包含以下参数。

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