OnsRegionList - 获取地域信息列表

调用OnsRegionList获取消息队列RocketMQ版目前开放服务的地域(Region)信息列表。

接口说明

注意阿里云提供的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 array

查询结果。

object
RegionName string

地域名称。

华东1(杭州)
OnsRegionId string

地域的ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****",
  "Data": {
    "RegionDo": [
      {
        "RegionName": "华东1(杭州)",
        "OnsRegionId": "cn-hangzhou"
      }
    ]
  }
}

错误码

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

阿里云首页 消息队列 MQ 相关技术圈