You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2025.05.12 18:01:38首次发布时间:2021.11.10 18:21:34
我的收藏
有用
有用
无用
无用

公共请求参数,是指调用任意API时都需要使用到的请求参数,即您每次使用火山引擎API发送请求时,都需要携带这些公共请求参数,否则会导致请求失败。
公共请求参数首字母均为大写,以此区分其他请求参数。

Action&Version

不同的OpenAPIActionVersion是不同的,详情请参考OpenAPI的公共参数章节。

注意

Action 和 Version 必须放在 Query 中。

名称类型是否必填参数格式描述
ActionString[a-zA-Z]+接口名称,与具体的接口相关。
VersionStringYYYY-MM-DD接口的版本信息,与具体的接口相关。
X-ExpiresInt300签名的有效时间,单位为秒,不填时默认为 900 秒。

签名参数

签名参数是请求必不可少的部分,可以在 Header 或 Query 中。

在 Header 中的场景

名称类型是否必填描述
X-DateString使用 UTC 时间,精确到秒,格式为YYYYMMDD'T'HHMMSS'Z',例如20201103T104027Z
AuthorizationString用于验证请求合法性的认证信息。格式为:HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

Authorization 中的信息含义如下:

名称类型备注
AccessKeyString请求的 Access Key ID。
ShortDateString请求的短时间,精确到日。使用 UTC 时间,例如20180201
RegionString请求的地域(Region),例如cn-beijing表示华北 2(北京)地域。更多 Region 信息,请参见 地域限制
ServiceNameString请求的服务,调用云监控API时为Volc_Observe
SignedHeadersString参与签名的 Header,多个用分号;隔开。
SignatureString计算完毕的签名,签名计算方式请参见 签名机制

在Query中的场景

X-Date 与 Authorization 的信息可以直接存在 Query 当中。

名称类型是否必填描述
X-DateString使用 UTC 时间,精确到秒,例如20201103T104027Z
X-AlgorithmString固定为HMAC-SHA256,为将来扩展做准备。
X-CredentialString{AccessKey}/{ShortDate}/{Region}/{Service}/request组成。
X-SignedHeadersString参与签名的 Header,多个用分号;隔开。
X-SignatureString计算完毕的签名,签名计算方式请参见 签名机制