The Message Queue for Apache RocketMQ API allows you to make API requests by using HTTP, SDKs, and OpenAPI Explorer.

Call API operations by using HTTP

Message Queue for Apache RocketMQ API operations use the RPC protocol. You can call Message Queue for Apache RocketMQ API operations by sending HTTP GET requests.

The request syntax is as follows:
http://Endpoint/?Action=xx&Parameters
where:
  • Endpoint: the endpoint of the Message Queue for Apache RocketMQ API is ons.[regionId].aliyuncs.com. For more information about [ regionId], see Endpoints.
  • Action: the name of the operation being performed. For example, to apply for a token, you must set the Action parameter to ApplyToken.
  • Version: the version of the API. For example, the version of the Message Queue for Apache RocketMQ API is 2019-02-14.
  • Parameters: the request parameters for the operation. Separate multiple parameters with ampersands (&).

    Request parameters include both common parameters and operation-specific parameters. Common request parameters include the API version and authentication-related parameters. For more information, see Common parameters.

Call API operations by using SDKs

The Message Queue for Apache RocketMQ API supports SDKs for multiple programming languages. The SDKs automatically sign requests for you. For more information, see Obtain the SDKs.

Call API operations by using OpenAPI Explorer

OpenAPI Explorer is a visual tool for calling APIs. OpenAPI Explorer allows you to call APIs of Alibaba Cloud services and APIs provided in Alibaba Cloud Marketplace. You can call these APIs on a webpage or command-line interface (CLI). In addition, OpenAPI Explorer allows you to view the request and response of each API call and dynamically generate SDK sample code.

You can call API operations by directly accessing OpenAPI Explorer or using debugging features in the API documentation.

Endpoints

The endpoint of the Message Queue for Apache RocketMQ API is ons.[regionId].aliyuncs.com. [regionId] is the ID of the region where the Message Queue for Apache RocketMQ instance is located.

The following table lists the supported regions of the Message Queue for Apache RocketMQ API, the corresponding region IDs, and domains.

Region regionId domain
Internet mq-internet-access ons.mq-internet-access.aliyuncs.com
China (Hangzhou) cn-hangzhou ons.cn-hangzhou.aliyuncs.com
China (Shanghai) cn-shanghai ons.cn-shanghai.aliyuncs.com
China (Qingdao) cn-qingdao ons.cn-qingdao.aliyuncs.com
China (Beijing) cn-beijing ons.cn-beijing.aliyuncs.com
China (Zhangjiakou-Beijing Winter Olympic) cn-zhangjiakou ons.cn-zhangjiakou.aliyuncs.com
China (Hohhot) cn-huhehaote ons.cn-huhehaote.aliyuncs.com
China (Shenzhen) cn-shenzhen ons.cn-shenzhen.aliyuncs.com
China (Chengdu) cn-chengdu ons.cn-chengdu.aliyuncs.com
China (Hong Kong) cn-hongkong ons.cn-hongkong.aliyuncs.com
Singapore (Singapore) ap-southeast-1 ons.ap-southeast-1.aliyuncs.com
Australia (Sydney) ap-southeast-2 ons.ap-southeast-2.aliyuncs.com
Malaysia (Kuala Lumpur) ap-southeast-3 ons.ap-southeast-3.aliyuncs.com
Indonesia (Jakarta) ap-southeast-5 ons.ap-southeast-5.aliyuncs.com
Japan (Tokyo) ap-northeast-1 ons.ap-northeast-1.aliyuncs.com
Germany (Frankfurt) eu-central-1 ons.eu-central-1.aliyuncs.com
UK (London) eu-west-1 ons.eu-west-1.aliyuncs.com
US (Virginia) us-east-1 ons.us-east-1.aliyuncs.com
US (Silicon Valley) us-west-1 ons.us-west-1.aliyuncs.com
India (Mumbai) ap-south-1 ons.ap-south-1.aliyuncs.com
UAE (Dubai) me-east-1 ons.me-east-1.aliyuncs.com
China East 1 Finance cn-hangzhou-finance ons.cn-hangzhou-finance.aliyuncs.com
China South 1 Finance cn-shenzhen-finance-1 ons.cn-shenzhen-finance-1.aliyuncs.com
China East 2 Finance cn-shanghai-finance-1 ons.cn-shanghai-finance-1.aliyuncs.com
China North 2 Ali Gov cn-north-2-gov-1 ons.cn-north-2-gov-1.aliyuncs.com