本文介绍消息队列 RocketMQ版 API 请求的组成结构。
您可以通过发送 POST 请求来调用 RocketMQ 的 API 服务。HTTPS 请求的格式如下:
{URI-scheme}://{Endpoint}?Action={Action}&Version={Version}
其中:
rocketmq.volcengineapi.com
,详细说明请参考服务地址。YYYY-MM-DD
格式。消息队列 RocketMQ版号为固定值 2021-04-01
。https://rocketmq.volcengineapi.com/?Action=CreateAuthKey&Version=2021-04-01
火山引擎的 OpenAPI 请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口需要包含的,具体可参见公共参数小节。接口请求参数是各个接口特有的,详见各个接口描述。
HTTP请求的请求头(Header)中需要指定 Content-Type
和请求鉴权信息等参数。Content-type 指定了请求消息体的结构化格式,消息队列 RocketMQ版 的 Content-Type 固定为 application/json
。详细的参数列表及说明请参考公共参数。
请求消息体主要传递业务相关的其他请求参数。若请求消息体中参数支持中文,则中文字符必须为 UTF-8 编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE 操作类型的接口就不需要消息体,调用接口时,请参考各个 API 接口文档填写请求参数。
您可以使用curl、Postman或直接编写代码等方式发送请求调用API。例如CreateAuthKey接口的请求示例如下。
POST https://rocketmq.volcengineapi.com/?Action=CreateAuthKey&Version=2021-04-01 HTTP/1.1 Accept: application/json Content-Type: application/json Host: rocketmq.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK*********************/20210328/cn-beijing/rocketmq/request, SignedHeaders=x-date, Signature=********************* { "InstanceId": "MQ_INST_********", "Description": "newauthkey", "TopicDefaultPermission": "DENY" }