公共参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。
说明
Action 和 Version 必须放在 Query 当中.
名称 | 类型 | 是否必填 | 参数格式 | 描述 | 示例值 |
---|---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口名称。实际调用时请参考您使用的产品的 API 文档取值。 | CreateDomain |
Version | String | 是 | YYYY-MM-DD | 接口的版本。 实际调用时请参考您使用的产品的 API 文档取值。 | 2023-01-01 |
X-Expires | Int | 否 | 整数 | 签名的有效时间,单位为秒,默认值为 900。 | 900 |
说明
签名参数可以在 Query 中,也可以在 Header 中。
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
X-Date | String | 是 | 请求时间,用来标识请求发起的时间,使用 UTC 时间,精确到秒. | 20201103T104027+08:00 |
Authorization | String | 是 | HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature} | HMAC-SHA256 Credential=AKLTMjI2******TZkYzE/20201230/cn-north-1/iam/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=28eeabbbd72*******6ad7ed029a6d8a7 |
X-Security-Token | String | 否 | 指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的 SessionToken,使用长期密钥时无需填写该参数。 | STSeyJBY2NvdW50SW*****QxYmVkNTIyNzU4YmMyNjQ3YzRmNzZiNmRjYTViNzVhZDUyOTMwYTg1NjE5ZGEiLCJTZXNzaW9uTmFtZSI6ImNlc2hpYXNzdW1lIn0= |
Authorization 中的信息含义:
名称 | 类型 | 备注 | 示例值 |
---|---|---|---|
AccessKeyId | String | 请求的 Access Key ID。 | AKLTMjI2ODVl***NTM5OTZkYzE |
ShortDate | String | 请求时间的简短格式,通常以YYYYMMDD 的形式表示。 | 20180201 |
Region | String | 服务所在的地域。当您使用的产品按 Region 提供服务时,该参数值请填写您实际要访问的 Region;当您使用非 Region 服务类产品时,您可以填写任一 Region。 | cn-north-1 |
Service | String | 请求的服务名,请参考您使用的产品的 API 文档获取 Service 值。 | live |
SignedHeaders | String | 参与签名的 Header,多个 Header 间用分号分隔,目的是指明哪些 Header 参与签名计算,从而忽略请求被 proxy 添加的额外 Header,其中 host、x-date 如果存在 Header 中则必选参与。 | content-type;host;x-content-sha256;x-date |
Signature | String | 计算完毕的签名。 | 28eeabbbd726b87***2646f35b6ad029a6d8a7 |
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
X-Date | String | 是 | 使用 UTC 时间,精确到秒。 | 20201103T104027+08:00 |
X-Algorithm | String | 是 | 固定值:HMAC-SHA256 | HMAC-SHA256 |
X-Credential | String | 是 | 由{AccessKeyId}/{ShortDate}/{Region}/{Service}/request 组成。 | AKLTMjI2******TZkYzE/20201230/cn-north-1/iam/request |
X-SignedHeaders | String | 是 | 参与签名的 Header,多个 Header 间用分号分隔,目的是指明哪些 Header 参与签名计算,从而忽略请求被 proxy 添加的额外 Header,其中 host、x-date 如果存在 Header 中则必选参与。 | content-type;host;x-content-sha256;x-date |
X-Signature | String | 是 | 计算完毕的签名。 | 28eeabbbd726b87***2646f35b6ad029a6d8a7 |