本文介绍了在调用 API 时,必须要传递的公共参数。公共参数主要包括 API 版本和鉴权等信息。
签名参数可以在 Header 中,也可以在 Query 中。
参数 | 类型 | 是否必填 | 说明 |
---|
Action | String | 是 | 接口名称,即要执行的操作,例如CreateProject 。 |
Version | String | 是 | 接口版本。云原生消息引擎的接口版本为 2021-06-01。 |
X-Expires | Int | 否 | 签名的有效时间,单位为秒,不填时默认值为 900 秒。 |
X-Date | String | 是 | 使用 UTC 时间,精确到秒。格式为 YYYYMMDD'T'HHMMSS'Z' ,例如: 20201103T104027Z 。 |
Authorization | String | 是 | HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}
其中:
- AccessKeyId (String):发起请求的火山引擎账号的 Access Key ID。
- ShortDate (String):请求的短时间,使用 UTC 时间,精确到日,格式为
YYYYMMDD ,例如:20220201。 - Region (String):请求的地域,例如:cn-beijing。
- Service (String):请求的服务。云原生消息引擎的 API 请求服务为 BMQ。
- SignedHeaders (String):参与签名的 Header,多个 Header 时用分号(;)分隔。
- Signature (String):计算后的签名。
|
X-Security-Token | String | 否 | 指安全令牌服务(Security Token Service,STS) 颁发的临时安全凭证中的 SessionToken,使用长期密钥时无需填写该参数。 |
Query 签名参数
参数 | 类型 | 是否必填 | 说明 |
---|
Action | String | 是 | 接口名称,即要执行的操作,例如CreateProject 。 |
Version | String | 是 | 接口版本。云原生消息引擎的接口版本为 2021-06-01。 |
X-Expires | Int | 否 | 签名的有效时间,单位为秒,不填时默认值为 900 秒。 |
X-Date | String | 是 | 使用 UTC 时间,精确到秒。使格式为 YYYYMMDD'T'HHMMSS'Z' ,例如:20201103T104027Z 。 |
X-Algorithm | String | 是 | 固定值:HMAC-SHA256。 |
X-Credential | String | 是 | 认证信息,由{AccessKeyId}/{ShortDate}/{Region}/{Service}/request 组成。
其中: - AccessKeyId (String):发起请求的火山引擎账号的 Access Key ID。
- ShortDate (String):请求的短时间,使用 UTC 时间,精确到日,格式为
YYYYMMDD ,例如:20220201。 - Region (String):请求的地域,例如:cn-beijing。
- Service (String):请求的服务。云原生消息引擎的 API 请求服务为 BMQ。
|
X-SignedHeaders | String | 是 | 参与签名的 Header,多个 Header 时用分号(;)分隔。 |
X-Signature | String | 是 | 计算后的签名。 |