使用OnsRegionList获取服务地域列表-云消息队列 RocketMQ 版-阿里云-云消息队列 RocketMQ 版(RocketMQ)-阿里云帮助中心

接口说明

重要阿里云提供的 OpenAPI 属于管控类 API，用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成，消息收发的核心数据链路中严禁依赖 OpenAPI 实现，否则可能会导致链路产生风险。

在您使用 SDK 接入云消息队列 RocketMQ 版服务并进行管控操作时，需要依次指定两个地域的信息，第二个地域的信息才是通过 OnsRegionList 接口获取。具体场景如下：

将您的应用接入云消息队列 RocketMQ 版服务：根据您的应用的部署地域选择就近的 API 网关接入点，填写相应的 regionId。该 regionId 实际上只用于接入阿里云 OpenAPI 网关，因为云消息队列 RocketMQ 版通过阿里云 OpenAPI 平台（即 POP）来提供 API 服务。
连接要进行管控操作的地域：指定您要对哪个地域的云消息队列 RocketMQ 版资源进行操作，填写该地域相应的 ID。此时要填写的地域 ID，可通过 OnsRegionList 接口获取。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的，可用于排查和定位问题。	72D14A84-45E5-4E01-A6DB-F63C4721****
Data	object
RegionDo	array<object>	查询结果。
	object
UpdateTime	integer	更新时间。	1411623866000
RegionName	string	地域名称。	华东1（杭州）
ChannelName	string	渠道名称。	ALIYUN
CreateTime	integer	创建时间。	1411623866000
Id	integer	ID。	1
OnsRegionId	string	地域的 ID。	cn-hangzhou

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。