公共参数--弹性块存储-火山引擎

文档中心

导航

公共参数

最近更新时间：2023.05.15 19:43:08首次发布时间：2023.05.15 19:43:08

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

Action&Version

Action和Version必须放在query中。

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

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

名称	类型	是否必填	描述
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	请求的Region，例如：华北2（北京）：cn-beijing。更多Region信息请参见地域与可用区介绍。
Service	String	请求的服务，当前为storage_ebs。
SignedHeaders	String	参与签名的Header，用分号分隔。
Signature	String	计算完毕的签名，签名计算方式见签名机制。

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	是	参与签名的，用分号分隔。
X-Signature	String	是	计算完毕的签名，签名计算方式见签名机制。