OnsRegionList - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a control plane API that is used to manage and query resources for Alibaba Cloud services. Integrate this API only on the control plane. Do not use OpenAPI for core data links that send and receive messages. This can introduce security threats to your data links.

When you use a software development kit (SDK) to connect to ApsaraMQ for RocketMQ and perform control operations, you must specify information for two regions. The information for the second region is obtained by calling the OnsRegionList operation. The scenarios are as follows:

Connect your application to the ApsaraMQ for RocketMQ service: Select the nearest API Gateway endpoint based on the deployment region of your application and enter the corresponding regionId. This regionId is used only to connect to the Alibaba Cloud OpenAPI gateway. ApsaraMQ for RocketMQ provides API services through the Alibaba Cloud OpenAPI platform (POP).
Connect to the region for control operations: Specify the region where you want to manage ApsaraMQ for RocketMQ resources and enter the ID for that region. You can obtain this region ID by calling the OnsRegionList operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique ID of the request. This is a common parameter. Use this ID to troubleshoot and locate issues.	72D14A84-45E5-4E01-A6DB-F63C4721****
Data	object
RegionDo	array<object>	The query results.
	object
UpdateTime	integer	The update time.	1411623866000
RegionName	string	The name of the region.	华东1（杭州）
ChannelName	string	The name of the channel.	ALIYUN
CreateTime	integer	The creation time.	1411623866000
Id	integer	The ID.	1
OnsRegionId	string	The ID of the region.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****",
  "Data": {
    "RegionDo": [
      {
        "UpdateTime": 1411623866000,
        "RegionName": "华东1（杭州）",
        "ChannelName": "ALIYUN",
        "CreateTime": 1411623866000,
        "Id": 1,
        "OnsRegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.