You need to enable JavaScript to run this app.
导航
消息队列 RabbitMQ版
  • 文档首页
    • /
  • 消息队列 RabbitMQ版

公共参数

最近更新时间：2022.10.17 17:41:38

首次发布时间：2022.04.20 20:30:03

我的收藏

本文介绍每个接口都需要使用的请求参数和返回参数。

请求 URL 参数

参数类型是否必选含义
ActionString必选要执行的操作，如调用 DescribeInstances 查询已创建的消息队列 RabbitMQ版实例。
VersionString必选要使用的 API 版本，消息队列 RabbitMQ版的 API 版本是2018-01-01。
X-ExpiresInteger可选签名的有效时间，单位为秒，默认值为 900。

请求头参数

参数名类型是否必选含义
Content-TypeString必选指定了请求消息体的结构化格式，消息队列 RabbitMQ版的 Content-Type 固定为 application/json。

Host

String

必选

即服务地址 endpoint。消息队列 RabbitMQ版的服务地址固定为 rabbitmq.volcengineapi.com。
接入时，消息队列 RabbitMQ版默认根据用户所在的地域就近访问。同时，您也可以在 Authorization 中指定地域进行访问。

X-DateString必选这是您发出请求的日期和时间。在请求中指定日期有助于防止第三方拦截您的请求并稍后重新提交。该日期使用 ISO8601 Basic 格式，通过 X-Date 标头以 YYYYMMDD'T'HHMMSS'Z' 格式指定。

Authorization

String

必选

HTTP 标准身份认证头部字段。
格式为HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}。

Authorization 字段说明如下。

参数名类型是否必选含义
AccessKeyIdString必选访问服务使用的密钥 ID，即 Access Key ID。
ShortDateString必选请求服务时的 UTC 短时间，精确到日。格式为 YYYYMMDD，例如 20180201。
RegionString必选访问的服务地域 ID，例如 cn-beijing。消息队列 RabbitMQ版支持的地域列表请查看服务地址。
ServiceString必选访问的服务名称，消息队列 RabbitMQ版服务名称为rabbitmq。
SignedHeadersString必选参与签名的 Header，用分号分隔。例如 x-date。
SignatureString必选计算完毕的签名结果字符串。如何计算签名，请参考签名机制。