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

公共参数

最近更新时间2023.09.08 16:31:00

首次发布时间2023.09.08 16:31:00

公共请求参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎API发送请求时都需要携带这些公共请求参数,否则会导致请求失败。公共请求参数首字母均为大写,以此区分接口请求参数。

Action&Version

Action和Version必须放在query当中。

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

签名参数

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

在Header中的场景

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

Authorization中的信息含义如下:

名称类型备注
AccessKeyString请求的AK。
ShortDateString请求的短时间,精确到日。使用UTC时间,例如:20180201。
RegionString请求的Region,例如:华北2(北京):cn-beijing。
更多Region信息请参见地域与可用区介绍。
ServiceString请求的服务,调用DDH API时为:ecs。
SignedHeadersString参与签名的Header,用分号分隔。
SignatureString计算完毕的签名,签名计算方式见签名机制。

在Query中的场景

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

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