OnsRegionList - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Queries regions where ApsaraMQ for RocketMQ is available.

Operation description

Note API operations provided by Alibaba Cloud are used to manage and query resources of Alibaba Cloud services. We recommend that you integrate these API operations only in management systems. Do not use these API operations in the core system of messaging services. Otherwise, system risks may occur.

When you use an SDK to access and manage a ApsaraMQ for 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. You must apply for a public endpoint in the following scenarios:

Connect your application to ApsaraMQ for RocketMQ: Select the nearest API gateway endpoint based on the region where your application is deployed, and enter the corresponding region ID. The regionId is used to access Alibaba Cloud API Gateway because ApsaraMQ for 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 ApsaraMQ for RocketMQ resources and enter the region ID. You can call the OnsRegionList operation to query a region ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request. This parameter is a common parameter. Each request has a unique ID. You can use this ID to troubleshoot issues.	72D14A84-45E5-4E01-A6DB-F63C4721****
Data	object []	The returned data.
UpdateTime	long	The time when the instance was updated.	1411623866000
RegionName	string	The region name.	China (Hangzhou)
ChannelName	string	The channel name.	ALIYUN
CreateTime	long	The time when the instance was created.	1411623866000
Id	long	The instance ID.	1
OnsRegionId	string	The region ID.	cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****",
  "Data": {
    "RegionDo": [
      {
        "UpdateTime": 1411623866000,
        "RegionName": "China (Hangzhou)\n",
        "ChannelName": "ALIYUN",
        "CreateTime": 1411623866000,
        "Id": 1,
        "OnsRegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-12-08

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.