公共参数是每个 API 请求必须包含的参数。如果 API 请求中缺少公共参数。请求会失败。公共参数分为 URI 参数和签名参数。
URI 参数必须包含在 query string 中。
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| Action | string | 是 | 表示 API 名称。格式为 [a-zA-Z]+。 | DescribeContentQuota |
| Version | string | 是 | 表示 API 版本。格式为 YYYY-MM-DD。 | 2022-03-01 |
每个 API 请求必须包含签名参数。签名参数可以包含在 query string 中作为 URI 参数，也可以包含在 request headers 中。
如果在 request headers 中包含签名参数，必须包含以下参数。
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| X-Date | string | 是 | 表示签名的 UTC 时间，精确到秒。 | 20201103T104027Z |
| Authorization | string | 是 | 表示签名值。 | 参见 Authorization。 |
Authorization 的伪代码结构如下：
HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
{}内字段的信息如下。
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| AccessKey | string | 火山引擎账号的 AccessKey ID，可以从 秘钥管理 页面获取。 | AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE |
| ShortDate | string | 请求的时间，使用 UTC 时间，精确到日。 | 20210913 |
| Region | string | 请求的 Region。 | cn-north-1 |
| Service | string | 请求的服务名称。 | MCDN |
| 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 | 是 | 参见下面的说明。 | 参见下面的说明。 |
| X-SignedHeaders | string | 是 | 参与签名的 request headers。Request headers 之间以分号分隔。 | host;x-content-sha256;x-date |
| X-Signature | string | 是 | 计算后的签名。 | 关于更多签名的信息，参见签名机制。 |
X-Credential 的伪代码结构
{AccessKey}/{ShortDate}/{Region}/{Service}/request