最近更新时间:2022.09.01 11:30:05
首次发布时间:2022.09.01 11:30:05
公共请求参数是每个 API 请求必须包含的参数。如果 API 请求中缺少公共请求参数,请求会失败。
公共请求参数首字母均为大写,以此区分其他请求参数。公共请求参数分为 URI 参数和签名参数。
URI 参数必须包含在 query string 中。
名称 | 类型 | 是否必选 | 格式 | 说明 | 示例 |
---|---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称,与具体的接口相关,表示要执行的操作。 | CreateAccelerator |
Version | string | 是 | YYYY-MM-DD | API 版本信息。 | 2022-03-01 |
每个 API 请求必须包含签名参数。签名参数可以包含在 query string 中作为 URI 参数,也可以包含在 request headers 中。
如果在 request headers 中包含签名参数,必须包含以下参数。
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
X-Date | string | 是 | 表示签名的 UTC 时间,精确到秒。如20201103T104027Z |
Authorization | string | 是 | 表示签名值。
|
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 中包含签名参数,必须包含以下参数。
名称 | 类型 | 是否必选 | 描述 | 示例 |
---|---|---|---|---|
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 | 是 | 计算后的签名。 | 关于更多签名的信息,参见签名机制。 |