You need to enable JavaScript to run this app.
导航

公共参数

最近更新时间2023.12.11 15:05:21

首次发布时间2022.03.01 09:32:28

公共请求参数,是指调用任意OpenAPI时都需要使用到的请求参数,即您每次使用火山引擎OpenAPI发送请求时,都需要携带这些公共请求参数,否则会导致请求失败。

公共请求参数首字母均为大写,以此区分其他请求参数。

Action&Version

Action和Version必须放在Query当中。

名称
类型
是否必填
参数格式
描述
ActionString[a-zA-Z]+API名字,与具体的接口相关,表示要执行的操作。
VersionStringYYYY-MM-DDAPI的版本信息。
X-ExpiresInteger300签名的有效时间,单位:秒,不填默认900。

签名参数

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

签名参数在Header中的场景

名称
类型
是否必填
描述
X-DateString使用UTC时间,精确到秒,如:20201103T104027Z。
AuthorizationStringHMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}。

Authorization中的信息含义如下:

名称
类型
备注
AccessKeyString请求的AccessKey信息。
ShortDateString请求的短时间,精确到日。使用UTC时间,如:20180201。
RegionString请求的Region,例如:华北2(北京):cn-beijing。具体地域信息,请参见 地域介绍
ServiceString请求的服务,调用共享带宽包时为:vpc。
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计算完毕的签名,签名计算方式见 签名方法