调用DescribeRegions接口查询可用地域。

调试

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

请求头

该接口使用公共请求头，无特殊请求头。更多信息，请参见公共请求和返回头。

请求语法

GET /pop/v1/paas/regionConfig HTTP/1.1

请求参数

无

返回数据

名称 类型 示例值 描述
Message String success

调用结果的附加信息。
RequestId String DDE85827-B0B3-4E56-86E8-17C42009****

请求ID。
Regions Array of Region

地域列表。
Region
LocalName String 华东2（上海）

地域名称。取值说明如下：

  • 华东1（杭州）
  • 华东2（上海）
  • 华北2（北京）
  • 华北3（张家口）
  • 华南1（深圳）
  • 华南3（广州）
  • 中国（香港）
  • 新加坡
  • 美国（硅谷）
RegionEndpoint String sae.cn-shanghai.aliyuncs.com

地域对应的接入地址。取值说明如下：

  • sae.cn-hangzhou.aliyuncs.com
  • sae.cn-shanghai.aliyuncs.com
  • sae.cn-beijing.aliyuncs.com
  • sae.cn-zhangjiakou.aliyuncs.com
  • sae.cn-shenzhen.aliyuncs.com
  • sae.cn-guangzhou.aliyuncs.com
  • sae.cn-hongkong.aliyuncs.com
  • sae.ap-southeast-1.aliyuncs.com
  • sae.us-west-1.aliyuncs.com
RegionId String cn-shanghai

地域ID。取值说明如下：

  • cn-hangzhou：华东1（杭州）地域的ID。
  • cn-shanghai：华东2（上海）地域的ID。
  • cn-beijing：华北2（北京）地域的ID。
  • cn-zhangjiakou：华北3（张家口）地域的ID。
  • cn-shenzhen：华南1（深圳）地域的ID。
  • cn-guangzhou：华南3（广州）地域的ID。
  • cn-hongkong：中国香港地域的ID。
  • ap-southeast-1：新加坡地域的ID。
  • us-west-1：美国（硅谷）地域的ID。
RecommendZones Array of String cn-hongkong-b

推荐可用区。所有地域下，整体库存量相对充足的可用区。格式如下：

  • 如果地域内有推荐可用区："RecommendZone": ["cn-hongkong-b", "cn-hongkong-d", "cn-hongkong-c"]
  • 如果地域内无推荐可用区："RecommendZone": []
Code Integer 200

接口状态或POP错误码。取值说明如下：

  • 2xx：成功。
  • 3xx：重定向。
  • 4xx：请求错误。
  • 5xx：服务器错误。

示例

请求示例

GET /pop/v1/paas/regionConfig HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRegionsResponse>
    <Message>success</Message>
    <RequestId>DDE85827-B0B3-4E56-86E8-17C42009****</RequestId>
    <Regions>
        <LocalName>华东2（上海）</LocalName>
        <RegionEndpoint>sae.cn-shanghai.aliyuncs.com</RegionEndpoint>
        <RegionId>cn-shanghai</RegionId>
        <RecommendZones>cn-hongkong-b</RecommendZones>
    </Regions>
    <Code>200</Code>
</DescribeRegionsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "DDE85827-B0B3-4E56-86E8-17C42009****",
  "Regions" : [ {
    "LocalName" : "华东2（上海）",
    "RegionEndpoint" : "sae.cn-shanghai.aliyuncs.com",
    "RegionId" : "cn-shanghai",
    "RecommendZones" : [ "cn-hongkong-b" ]
  } ],
  "Code" : 200
}

错误码

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