文档

DescribeRegions - 查询可用地域

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeRegionsget
  • 全部资源
    *

请求语法

GET /pop/v1/paas/regionConfig

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

调用结果的附加信息。

success
RequestIdstring

请求 ID。

DDE85827-B0B3-4E56-86E8-17C42009****
Regionsarray<object>

地域列表。

object

地域数据。

LocalNamestring

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

  • 华东 1(杭州)
  • 华东 2(上海)
  • 华北 2(北京)
  • 华北 3(张家口)
  • 华南 1(深圳)
  • 华南 3(广州)
  • 中国(香港)
  • 新加坡
  • 美国(硅谷)
华东2(上海)
RegionEndpointstring

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

  • 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
sae.cn-shanghai.aliyuncs.com
RegionIdstring

地域 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。
cn-shanghai
RecommendZonesarray

推荐可用区。

string

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

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

  • 如果地域内无推荐可用区:"RecommendZone": []

cn-hongkong-b
Codeinteger

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

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-25OpenAPI 返回结构发生变更查看变更详情