公共请求参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。公共请求参数首字母均为大写,以此区分接口请求参数。
说明
Action 和 Version 必须在 Query 当中。
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateDataMigrateTask | 接口名称,表示要执行的操作。文件存储支持的操作列表,请参见 API 概览。 |
Version | String | 是 | 2018-01-01 | 接口的版本信息,当前版本为 |
X-Expires | Int | 否 | 300 | 签名的有效时间,单位秒,不填时默认为 900。 |
签名参数是请求必不可少的部分,参数可以在 Header 或 Query 中:
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
X-Date | String | 是 | 使用UTC时间,精确到秒,使用遵循ISO 8601标准的格式: | 20201103T104027Z |
Authorization | String | 是 | HTTP 标准身份认证头部字段。 格式为 | HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE/20201230/cn-north-1/iam/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=28eeabbbd726b87002e0fe58ad8c1c768e619b06e2646f35b6ad7ed029a6d8a7 |
其中,Authorization 中的信息含义如下表。
名称 | 类型 | 备注 |
---|---|---|
AccessKey | String | 请求的 AccessKey 信息。查看 AK/SK 信息的具体步骤,请参见查看 AK/SK 信息。 |
ShortDate | String | 请求的短时间,精确到日。使用 UTC 时间,例如:20180201。 |
Region | String | 请求的地域,例如:华北2(北京):cn-beijing。 |
ServiceName | String | 请求的服务,当前为 |
SignedHeaders | String | 参与签名的 Header,多个 Header 之间分号分隔。 |
Signature | String | 计算完毕的签名。签名计算方式详情,请参见签名机制。 |
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 20201103T104027Z, 使用 UTC 时间,精确到秒。 |
X-Algorithm | String | 是 | 固定值, HMAC-SHA256;为将来扩展做准备。 |
X-Credential | String | 是 | 由 |
X-SignedHeaders | String | 是 | 参与签名的 Header,多个 Header 之间用分号分隔。 |
X-Signature | String | 是 | 计算完毕的签名。签名计算方式详情,请参见签名机制。 |