You need to enable JavaScript to run this app.
导航
请求结构
最近更新时间:2023.07.12 18:12:21首次发布时间:2023.07.12 16:22:33

本文介绍消息队列 RocketMQ版 API 请求的组成结构。

请求格式

您可以通过发送 POST 请求来调用 RocketMQ 的 API 服务。HTTPS 请求的格式如下:

{URI-scheme}://{Endpoint}?Action={Action}&Version={Version}

其中:

  • URI-scheme:表示用于传输请求的协议,当前所有 API 均采用 HTTPS 协议。
  • Endpoint:指定承载服务端点的服务器域名或IP,即服务地址。消息队列 RocketMQ版的 Endpoint 为 rocketmq.volcengineapi.com,详细说明请参考服务地址
  • Action:要执行的操作,此处请填写要调用的 API 接口。消息队列 RocketMQ版的 API 接口请参考 API 概览
  • Version:API 版本号,格式为 YYYY-MM-DD 格式。消息队列 RocketMQ版号为固定值 2023-01-01
    以创建 RocketMQ 密钥为例,未编码的 HTTPS 请求 URL 如下。
https://rocketmq.volcengineapi.com/?Action=CreateAccessKey&Version=2023-01-01

请求参数

火山引擎的 OpenAPI 请求包含两类参数:公共请求参数和接口请求参数。其中,公共请求参数是每一个接口需要包含的,具体可参见公共参数小节。接口请求参数是各个接口特有的,详见各个接口描述。

请求头

HTTP请求的请求头(Header)中需要指定 Content-Type 和请求鉴权信息等参数。Content-type 指定了请求消息体的结构化格式,消息队列 RocketMQ版 的 Content-Type 固定为 application/json。详细的参数列表及说明请参考公共参数

请求消息体

请求消息体主要传递业务相关的其他请求参数。若请求消息体中参数支持中文,则中文字符必须为 UTF-8 编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE 操作类型的接口就不需要消息体,调用接口时,请参考各个 API 接口文档填写请求参数。

发起请求

您可以使用curlPostman或直接编写代码等方式发送请求调用API。例如CreateAccessKey接口的请求示例如下。

POST /?Action=CreateAccessKey&Version=2023-01-01 HTTP/1.1
Content-Type: application/json
Host: rocketmq.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-shanghai/rocketmq/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "rocketmq-cnai1f0c29ca****",
  "Description": "test",
  "AllAuthority": "ALL"
}