You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2024.07.02 21:03:12首次发布时间:2024.07.02 21:03:12

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

Action 和 Version

注意

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

Region

String

请求的地域(Region),例如:cn-beijing,表示华北2(北京)地域。

说明

CP 为 global 服务,不区分地域。此处填写 cn-beijing/cn-guangzhou/cn-shanghai 均可。

ServiceString请求的服务,调用持续交付 API 时为:cp
SignedHeadersString参与签名的 Header,用分号(;)分隔。
SignatureString计算完毕的签名。签名计算方式,请参见 签名机制

在 Query 中的场景

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

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