公共请求参数,是指调用任意API时都需要使用到的请求参数,即您每次使用火山引擎API发送请求时,都需要携带这些公共请求参数,否则会导致请求失败。
公共请求参数首字母均为大写,以此区分其他请求参数。
不同的OpenAPI
的Action
和Version
是不同的,详情请参考OpenAPI
的公共参数章节。
注意
Action 和 Version 必须放在 Query 中。
名称 | 类型 | 是否必填 | 参数格式 | 描述 |
---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口名称,与具体的接口相关。 |
Version | String | 是 | YYYY-MM-DD | 接口的版本信息,与具体的接口相关。 |
X-Expires | Int | 否 | 300 | 签名的有效时间,单位为秒,不填时默认为 900 秒。 |
签名参数是请求必不可少的部分,可以在 Header 或 Query 中。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用 UTC 时间,精确到秒,格式为YYYYMMDD'T'HHMMSS'Z' ,例如20201103T104027Z 。 |
Authorization | String | 是 | 用于验证请求合法性的认证信息。格式为:HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature} 。 |
Authorization 中的信息含义如下:
名称 | 类型 | 备注 |
---|---|---|
AccessKey | String | 请求的 Access Key ID。 |
ShortDate | String | 请求的短时间,精确到日。使用 UTC 时间,例如20180201 。 |
Region | String | 请求的地域(Region),例如cn-beijing 表示华北 2(北京)地域。更多 Region 信息,请参见 地域限制。 |
ServiceName | String | 请求的服务,调用云监控API时为Volc_Observe 。 |
SignedHeaders | String | 参与签名的 Header,多个用分号; 隔开。 |
Signature | String | 计算完毕的签名,签名计算方式请参见 签名机制。 |
X-Date 与 Authorization 的信息可以直接存在 Query 当中。
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
X-Date | String | 是 | 使用 UTC 时间,精确到秒,例如20201103T104027Z 。 |
X-Algorithm | String | 是 | 固定为HMAC-SHA256 ,为将来扩展做准备。 |
X-Credential | String | 是 | 由{AccessKey}/{ShortDate}/{Region}/{Service}/request 组成。 |
X-SignedHeaders | String | 是 | 参与签名的 Header,多个用分号; 隔开。 |
X-Signature | String | 是 | 计算完毕的签名,签名计算方式请参见 签名机制。 |