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

公共参数

最近更新时间2024.03.11 17:53:27

首次发布时间2023.11.30 14:19:26

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

Action和Version

Action 和 Version 必须在 Query 当中。

名称

类型

是否必填

参数格式

描述

Action

String

[a-zA-Z]+

接口的名字,与具体的接口相关,表示要执行的操作。

Version

String

YYYY-MM-DD

接口的版本信息,当前版本为 2023-01-01

X-Expires

Int

300

签名的有效时间,单位秒,默认不填是 900 秒。

签名参数

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

  • 在Header中的场景

    名称

    类型

    是否必填

    描述

    X-Date

    String

    20201103T104027Z, 使用 UTC 时间,精确到秒。

    Authorization

    String

    HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

    其中,Authorization中的信息含义如下表。

    名称

    类型

    备注

    AccessKey

    String

    请求的AK。

    ShortDate

    String

    请求的短时间,精确到日。使用UTC时间,例如:20180201。

    Region

    String

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

    ServiceName

    String

    请求的服务,当前为ESCloud。

    SignedHeaders

    String

    参与签名的Header,用分号分隔。

    Signature

    String

    计算完毕的签名。签名计算方式详情,请参见签名机制

  • 在Query中的场景

    说明

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

    名称

    类型

    是否必填

    描述

    X-Date

    String

    20201103T104027Z, 使用 UTC 时间,精确到秒。

    X-Algorithm

    String

    固定值, HMAC-SHA256;为将来扩展做准备。

    X-Credential

    String

    由‘{AccessKey}/{ShortDate}/{Region}/{Service}/request’组成。

    X-SignedHeaders

    String

    参与签名的 Header,用分号分隔。

    X-Signature

    String

    计算完毕的签名。签名计算方式详情,请参见签名机制