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

公共参数

最近更新时间2023.03.31 16:12:20

首次发布时间2021.11.10 18:21:34

公共请求参数,是指调用任意API时都需要使用到的请求参数,即您每次使用火山引擎API发送请求时,都需要携带这些公共请求参数,否则会导致请求失败。
公共请求参数首字母均为大写,以此区分其他请求参数。

Action&Version

不同的OpenAPIActionVersion是不同的,详情请参考OpenAPI的公共参数章节。

注意

Action和Version必须放在Query中。

名称

类型

是否必填

参数格式

描述

Action

String

[a-zA-Z]+

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

Version

String

YYYY-MM-DD

API版本信息,当前版本为:2018-01-01。

X-Expires

Int

300

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

签名参数

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

在Header中的场景

名称

类型

是否必填

描述

X-Date

String

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

Authorization

String

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

Authorization中的信息含义如下:

名称

类型

备注

AccessKey

String

请求的AccessKey信息。

ShortDate

String

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

Region

String

请求的Region,例如:华北2(北京):cn-beijing。更多Region信息,请参见地域限制

ServiceName

String

请求的服务,调用云监控API时为Volc_Observe。

SignedHeaders

String

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

Signature

String

计算完毕的签名,签名计算方式见签名机制。

X-TT-Logid

String

请求ID,生成算法请保持一致性。

在Query中的场景

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

名称

类型

是否必填

描述

X-Date

String

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

X-Algorithm

String

当前固定为:HMAC-SHA256。为将来扩展做准备。

X-Credential

String

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

X-SignedHeaders

String

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

X-Signature

String

计算完毕的签名,签名计算方式见签名机制。