文档

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
RequestIdstring

公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

72D14A84-45E5-4E01-A6DB-F63C4721****
Dataobject []

查询结果。

UpdateTimelong

更新时间。

1411623866000
RegionNamestring

地域名称。

华东1(杭州)
ChannelNamestring

渠道名称。

ALIYUN
CreateTimelong

创建时间。

1411623866000
Idlong

ID。

1
OnsRegionIdstring

地域的 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"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更