You need to enable JavaScript to run this app.
导航
公共参数
最近更新时间:2023.12.22 15:21:10首次发布时间:2022.04.12 11:06:53

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

Action和Version

说明

Action 和 Version 必须在 Query 当中。

名称类型是否必填参数格式描述
ActionString[a-zA-Z]+接口的名字,与具体的接口相关,表示要执行的操作。
VersionStringYYYY-MM-DD接口的版本信息,当前版本为 2022-01-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请求的地域,例如:华北 2(北京):cn-beijing。
    ServiceString请求的服务,当前为 mongodb。
    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计算完毕的签名。签名计算方式详情,请参见签名机制

更多详情,请参见公共参数