公共请求参数是每个接口都需要使用的请求参数,开发者每次使用火山引擎 API 发送请求时都需要携带这些公共请求参数,否则会导致请求失败。
说明
Action 和 Version 必须在 Query 当中。
名称 | 类型 | 是否必填 | 参数格式 | 描述 |
---|---|---|---|---|
Action | String | 是 | [a-zA-Z]+ | 接口的名字,与具体的接口相关,表示要执行的操作。 |
Version | String | 是 | YYYY-MM-DD | 接口的版本信息,当前版本为 2018-01-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 | 请求的地域,例如:华北 2(北京),cn-beijing。 |
Service | String | 请求的服务,当前为 hbase。 |
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 | 是 | 参与签名的 Header,用分号分隔。 |
X-Signature | String | 是 | 计算完毕的签名。签名计算方式详情,请参见签名机制。 |
更多详情,请参见公共参数。