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

使用说明

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

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

QPS限制

本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

授权信息

阿里云账号和RAM用户调用该接口,均不需要进行授权。更多信息,请参见权限策略和示例

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsRegionList

系统规定参数。取值:OnsRegionList

返回数据

名称 类型 示例值 描述
Data Array of RegionDo

查询结果。

RegionDo
OnsRegionId String cn-hangzhou

地域的ID。

RegionName String 华东1(杭州)

地域名称。

RequestId String 72D14A84-45E5-4E01-A6DB-F63C4721****

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

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=OnsRegionList
&<公共请求参数>

正常返回示例

XML格式

<OnsRegionListResponse>
  <Data>
        <RegionDo>
              <RegionName>公网</RegionName>
              <OnsRegionId>mq-internet-access</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华北1(青岛)</RegionName>
              <OnsRegionId>cn-qingdao</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华南1(深圳)</RegionName>
              <OnsRegionId>cn-shenzhen</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华东1(杭州)</RegionName>
              <OnsRegionId>cn-hangzhou</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华北2(北京)</RegionName>
              <OnsRegionId>cn-beijing</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华东2(上海)</RegionName>
              <OnsRegionId>cn-shanghai</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>西南1(成都)</RegionName>
              <OnsRegionId>cn-chengdu</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华北3(张家口)</RegionName>
              <OnsRegionId>cn-zhangjiakou</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>华北5(呼和浩特)</RegionName>
              <OnsRegionId>cn-huhehaote</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>中国(香港)</RegionName>
              <OnsRegionId>cn-hongkong</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>新加坡</RegionName>
              <OnsRegionId>ap-southeast-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>日本(东京)</RegionName>
              <OnsRegionId>ap-northeast-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>马来西亚(吉隆坡)</RegionName>
              <OnsRegionId>ap-southeast-3</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>印度(孟买)</RegionName>
              <OnsRegionId>ap-south-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>阿联酋(迪拜)</RegionName>
              <OnsRegionId>me-east-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>德国(法兰克福)</RegionName>
              <OnsRegionId>eu-central-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>美国(硅谷)</RegionName>
              <OnsRegionId>us-west-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>美国(弗吉尼亚)</RegionName>
              <OnsRegionId>us-east-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>澳大利亚(悉尼)</RegionName>
              <OnsRegionId>ap-southeast-2</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>英国(伦敦)</RegionName>
              <OnsRegionId>eu-west-1</OnsRegionId>
        </RegionDo>
        <RegionDo>
              <RegionName>印度尼西亚(雅加达)</RegionName>
              <OnsRegionId>ap-southeast-5</OnsRegionId>
        </RegionDo>
  </Data>
  <RequestId>72D14A84-45E5-4E01-A6DB-F63C4721****</RequestId>
</OnsRegionListResponse>

JSON格式

{
	"Data": {
		"RegionDo": [
			{
				"RegionName": "公网",
				"OnsRegionId": "mq-internet-access"
			},
			{
				"RegionName": "华北1(青岛)",
				"OnsRegionId": "cn-qingdao"
			},
			{
				"RegionName": "华南1(深圳)",
				"OnsRegionId": "cn-shenzhen"
			},
			{
				"RegionName": "华东1(杭州)",
				"OnsRegionId": "cn-hangzhou"
			},
			{
				"RegionName": "华北2(北京)",
				"OnsRegionId": "cn-beijing"
			},
			{
				"RegionName": "华东2(上海)",
				"OnsRegionId": "cn-shanghai"
			},
			{
				"RegionName": "西南1(成都)",
				"OnsRegionId": "cn-chengdu"
			},
			{
				"RegionName": "华北3(张家口)",
				"OnsRegionId": "cn-zhangjiakou"
			},
			{
				"RegionName": "华北5(呼和浩特)",
				"OnsRegionId": "cn-huhehaote"
			},
			{
				"RegionName": "中国(香港)",
				"OnsRegionId": "cn-hongkong"
			},
			{
				"RegionName": "新加坡",
				"OnsRegionId": "ap-southeast-1"
			},
			{
				"RegionName": "日本(东京)",
				"OnsRegionId": "ap-northeast-1"
			},
			{
				"RegionName": "马来西亚(吉隆坡)",
				"OnsRegionId": "ap-southeast-3"
			},
			{
				"RegionName": "印度(孟买)",
				"OnsRegionId": "ap-south-1"
			},
			{
				"RegionName": "阿联酋(迪拜)",
				"OnsRegionId": "me-east-1"
			},
			{
				"RegionName": "德国(法兰克福)",
				"OnsRegionId": "eu-central-1"
			},
			{
				"RegionName": "美国(硅谷)",
				"OnsRegionId": "us-west-1"
			},
			{
				"RegionName": "美国(弗吉尼亚)",
				"OnsRegionId": "us-east-1"
			},
			{
				"RegionName": "澳大利亚(悉尼)",
				"OnsRegionId": "ap-southeast-2"
			},
			{
				"RegionName": "英国(伦敦)",
				"OnsRegionId": "eu-west-1"
			},
            {
				"RegionName": "印度尼西亚(雅加达)",
				"OnsRegionId": "ap-southeast-5"
			}
		]
	},
	"RequestId": "72D14A84-45E5-4E01-A6DB-F63C4721****"
}

错误码

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