消息队列 RocketMQ 版 API 接口的调用是向服务端地址发送 HTTP 请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用 UTF-8 字符集进行编码。

服务地址

消息队列 RocketMQ 版的 API 接入地址为 ons.[regionId].aliyuncs.com。其中,[regionId]消息队列 RocketMQ 版实例所在地域的 ID。

消息队列 RocketMQ 版支持的 OpenAPI 地域,以及对应的 regionId 和 domain 如下表所示。

地域名称 regionId domain
公网 mq-internet-access ons.mq-internet-access.aliyuncs.com
华东1(杭州) cn-hangzhou ons.cn-hangzhou.aliyuncs.com
华东2(上海) cn-shanghai ons.cn-shanghai.aliyuncs.com
华北1(青岛) cn-qingdao ons.cn-qingdao.aliyuncs.com
华北2(北京) cn-beijing ons.cn-beijing.aliyuncs.com
华北3(张家口) cn-zhangjiakou ons.cn-zhangjiakou.aliyuncs.com
华北5(呼和浩特) cn-huhehaote ons.cn-huhehaote.aliyuncs.com
华南1(深圳) cn-shenzhen ons.cn-shenzhen.aliyuncs.com
西南1(成都) cn-chengdu ons.cn-chengdu.aliyuncs.com
中国(香港) cn-hongkong ons.cn-hongkong.aliyuncs.com
新加坡(新加坡) ap-southeast-1 ons.ap-southeast-1.aliyuncs.com
澳大利亚(悉尼) ap-southeast-2 ons.ap-southeast-2.aliyuncs.com
马来西亚(吉隆坡) ap-southeast-3 ons.ap-southeast-3.aliyuncs.com
印度尼西亚(雅加达) ap-southeast-5 ons.ap-southeast-5.aliyuncs.com
日本(东京) ap-northeast-1 ons.ap-northeast-1.aliyuncs.com
德国(法兰克福) eu-central-1 ons.eu-central-1.aliyuncs.com
英国(伦敦) eu-west-1 ons.eu-west-1.aliyuncs.com
美国(弗吉尼亚) us-east-1 ons.us-east-1.aliyuncs.com
美国(硅谷) us-west-1 ons.us-west-1.aliyuncs.com
印度(孟买) ap-south-1 ons.ap-south-1.aliyuncs.com
阿联酋(迪拜) me-east-1 ons.me-east-1.aliyuncs.com
华东1 金融云 cn-hangzhou-finance ons.cn-hangzhou-finance.aliyuncs.com
华南1 金融云 cn-shenzhen-finance-1 ons.cn-shenzhen-finance-1.aliyuncs.com
华东2 金融云 cn-shanghai-finance-1 ons.cn-shanghai-finance-1.aliyuncs.com
华北2 阿里政务云1 cn-north-2-gov-1 ons.cn-north-2-gov-1.aliyuncs.com

通信协议

支持通过 HTTP 或 HTTPS 协议进行请求通信。为了获得更高的安全性,推荐您使用 HTTPS 协议发送请求。

请求语法

消息队列 RocketMQ 版提供 RESTful API 供您使用,其请求结构如下。

HTTPMethod /resource_URI_parameters
RequestHeader
RequestBody
其中:
  • HTTPMethod :请求使用的方法。
  • resource_URI_parameters:请求要调用的资源标示符,如/cluster
  • RquestHeader:请求头信息,通常包含 API 的版本、Host、Authorization 等信息。更多信息,请参见公共参数

    请求参数由公共请求头和 API 自定义参数组成。公共请求头中包含 API 版本号、身份验证等信息。

  • RequestBody:请求参数。

示例

http://xxxxx&<公共请求参数>
{
  "AppName","app1",
  "AppDescription","This is an application",
  "CategoryName","Java",
}

请求编码

请求及返回结果都使用 UTF-8 字符集进行编码。