全部产品
云市场

OnsRegionList

更新时间:2019-09-13 23:06:02

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

描述

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

  • 将您的应用接入消息队列 MQ 服务:根据您的应用的部署地域选择就近的 API 网关接入点,填写相应的 RegionId。该 RegionId 实际上只用于接入阿里云 OpenAPI 网关,因为消息队列 MQ 通过阿里云 OpenAPI 平台 (即 POP)来提供 API 服务。

  • 连接要进行管控操作的地域:指定您要对哪个地域的消息队列 MQ 资源进行操作,填写该地域相应的 RegionId。此时要填写的 RegionId 即可通过 OnsRegionList 接口获取。

请求参数列表

名称 类型 是否必需 描述
PreventCache Long 用于 CSRF 校验,设置为系统当前时间即可,单位毫秒(ms)

返回参数列表

名称 类型 描述
RequestId String 为公共参数,每个请求的 ID 都是唯一的
HelpUrl String 帮助链接
Data List(RegionDo) 查询结果

RegionDo 数据结构列表

名称 类型 描述
Id Long 数据库中编号
RegionId String 地域的 ID,例如 “cn-hangzhou”
RegionName String 地域名称,例如“华东1(杭州)”

使用示例

示例代码请参见管控 API 示例代码和接入点列表