Queries regions where Message Queue for Apache RocketMQ is available.

Usage notes

When you use the SDK to access and manage a Message Queue for Apache RocketMQ instance, you must sequentially specify the information about two regions. You can query the information about the second region by calling the OnsRegionList operation. This includes the following scenarios:

  • Connect your application to Message Queue for Apache RocketMQ: Select the nearest API gateway endpoint based on the region where your application is deployed, and enter the corresponding region ID. The region ID is used to access Alibaba Cloud API Gateway because Message Queue for Apache RocketMQ instances provide API services by using the OpenAPI Explorer platform, which is also called POP.
  • Access a region to manage its resources: Specify a region where you want to manage Message Queue for Apache RocketMQ resources and enter the region ID. You can query the region ID by calling the OnsRegionList operation.

QPS limit

The queries-per-second (QPS) limit on this operation is 50 per user. Throttling is triggered when the number of calls to this operation per second exceeds the QPS limit. Throttling may affect your business. Therefore, call this operation based on your needs. For more information, see QPS limits.

Authorization information

Alibaba Cloud accounts and RAM users can call this operation without the need to be authorized. For more information, see Policies and examples.

Request parameters

Parameter Type Required Example Description
Action String Yes OnsRegionList

The operation that you want to perform. Set the value to OnsRegionList.

Response parameters

Parameter Type Example Description
Data Array of RegionDo

The returned results.
RegionDo
OnsRegionId String cn-hangzhou

The region ID.
RegionName String China (Hangzhou)

The name of the region.
RequestId String 72D14A84-45E5-4E01-A6DB-F63C4721****

The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating.

Examples

Sample requests

http(s)://ons.cn-hangzhou.aliyuncs.com/? Action=OnsRegionList
&<Common request parameters>

Sample success responses

XML format 

<OnsRegionListResponse>
  <Data>
        <RegionDo>
              <RegionName>Internet</RegionName>
              <OnsRegionId>mq-internet-access</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Qingdao)</RegionName>
              <OnsRegionId>cn-qingdao</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Shenzhen)</RegionName>
              <OnsRegionId>cn-shenzhen</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Hangzhou)</RegionName>
              <OnsRegionId>cn-hangzhou</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Beijing)</RegionName>
              <OnsRegionId>cn-beijing</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Shanghai)</RegionName>
              <OnsRegionId>cn-shanghai</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Chengdu)</RegionName>
              <OnsRegionId>cn-chengdu</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Zhangjiakou)</RegionName>
              <OnsRegionId>cn-zhangjiakou</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Hohhot)</RegionName>
              <OnsRegionId>cn-huhehaote</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>China (Hong Kong)</RegionName>
              <OnsRegionId>cn-hongkong</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Singapore (Singapore)</RegionName>
              <OnsRegionId>ap-southeast-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Japan (Tokyo)</RegionName>
              <OnsRegionId>ap-northeast-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Malaysia (Kuala Lumpur)</RegionName>
              <OnsRegionId>ap-southeast-3</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>India (Mumbai)</RegionName>
              <OnsRegionId>ap-south-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>UAE (Dubai)</RegionName>
              <OnsRegionId>me-east-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Germany (Frankfurt)</RegionName>
              <OnsRegionId>eu-central-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>US (Silicon Valley)</RegionName>
              <OnsRegionId>us-west-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>US (Virginia)</RegionName>
              <OnsRegionId>us-east-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Australia (Sydney)</RegionName>
              <OnsRegionId>ap-southeast-2</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>UK (London)</RegionName>
              <OnsRegionId>eu-west-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>Indonesia (Jakarta)</RegionName>
              <OnsRegionId>ap-southeast-5</OnsRegionId>
        </RegionDo>
  </Data>
  <RequestId>72D14A84-45E5-4E01-A6DB-F63C4721****</RequestId>
</OnsRegionListResponse>

JSON format 

{
    "Data": {
        "RegionDo": [
            {
                "RegionName": "Internet",
                "OnsRegionId": "mq-internet-access"
            },
            {
                "RegionName": "China (Qingdao)",
                "OnsRegionId": "cn-qingdao"
            },
            {
                "RegionName": "China (Shenzhen)",
                "OnsRegionId": "cn-shenzhen"
            },
            {
                "RegionName": "China (Hangzhou)",
                "OnsRegionId": "cn-hangzhou"
            },
            {
                "RegionName": "China (Beijing)",
                "OnsRegionId": "cn-beijing"
            },
            {
                "RegionName": "China (Shanghai)",
                "OnsRegionId": "cn-shanghai"
            },
            {
                "RegionName": "China (Chengdu)",
                "OnsRegionId": "cn-chengdu"
            },
            {
                "RegionName": "China (Zhangjiakou)",
                "OnsRegionId": "cn-zhangjiakou"
            },
            {
                "RegionName": "China (Hohhot)",
                "OnsRegionId": "cn-huhehaote"
            },
            {
                "RegionName": "China (Hong Kong)",
                "OnsRegionId": "cn-hongkong"
            },
            {
                "RegionName": "Singapore (Singapore)",
                "OnsRegionId": "ap-southeast-1"
            },
            {
                "RegionName": "Japan (Tokyo)",
                "OnsRegionId": "ap-northeast-1"
            },
            {
                "RegionName": "Malaysia (Kuala Lumpur)",
                "OnsRegionId": "ap-southeast-3"
            },
            {
                "RegionName": "India (Mumbai)",
                "OnsRegionId": "ap-south-1"
            },
            {
                "RegionName": "UAE (Dubai)",
                "OnsRegionId": "me-east-1"
            },
            {
                "RegionName": "Germany (Frankfurt)",
                "OnsRegionId": "eu-central-1"
            },
            {
                "RegionName": "US (Silicon Valley)",
                "OnsRegionId": "us-west-1"
            },
            {
                "RegionName": "US (Virginia)",
                "OnsRegionId": "us-east-1"
            },
            {
                "RegionName": "Australia (Sydney)",
                "OnsRegionId": "ap-southeast-2"
            },
            {
                "RegionName": "UK (London)",
                "OnsRegionId": "eu-west-1"
            },
            {
                "RegionName": "Indonesia (Jakarta)",
                "OnsRegionId": "ap-southeast-5"
            }
        ]
    },
    "RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****"
}

Error codes

For a list of error codes, visit the API Error Center.