文档首页/ MapReduce服务 MRS/ API参考/ API V1.1/ 可用区/ 查询可用区信息
更新时间：2024-08-07 GMT+08:00
查看PDF
分享

查询可用区信息

功能介绍

在创建集群时，需要配置实例所在的可用区ID，可通过该接口查询可用区的ID。

URI

GET /v1.1/{region_id}/available-zones

表1 路径参数

参数

是否必选

参数类型

描述

region_id

是

String

参数解释：

区域ID。

约束限制：

不涉及

取值范围：

长度为[1-255]个字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

scope

否

String

参数解释：

可用区范围。

约束限制：

不涉及

取值范围：

  • Center：表示作用域为中心。
  • Edge：表示作用域为边缘。

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

available_zones

Array of AvailableZoneV2 objects

参数解释：

可用区列表，AvailableZoneV2参数说明请参见表4。

default_az_code

String

参数解释：

默认可用区编码。

取值范围：

不涉及。

support_physical_az_group

Boolean

参数解释：

支持的物理可用区分组。

取值范围：

  • True：支持物理可用区分组。
  • False：不支持物理可用区分组。
表4 AvailableZoneV2

参数

参数类型

描述

id

String

参数解释：

可用区编码。

取值范围：

不涉及

az_code

String

参数解释：

可用区编码。

取值范围：

不涉及

az_name

String

参数解释：

可用区名称。

取值范围：

不涉及

az_id

String

参数解释：

可用区ID。

取值范围：

不涉及

status

String

参数解释：

可用区状态。

取值范围：

不涉及

region_id

String

参数解释：

区域ID。

取值范围：

不涉及

az_group_id

String

参数解释：

可用区分组ID。

取值范围：

不涉及

az_type

String

参数解释：

可用区类型。

取值范围：

  • Core：核心
  • Satellite：卫星
  • Dedicated：专属
  • Virtual：虚拟
  • Edge：边缘
  • EdgeCental：中心边缘

az_tags

AvailableTag object

参数解释：

可用区标签，AvailableTag参数说明请参见表5。
表5 AvailableTag

参数

参数类型

描述

mode

String

参数解释：

模式，分为专属dedicated和共享shared。

取值范围：

  • dedicated：专属可用区。
  • shared：共享可用区。

alias

String

参数解释：

AZ的别名。

取值范围：

不涉及

public_border_group

String

参数解释：

所属group，默认为“center”。

取值范围：

不涉及

请求示例

无

响应示例

状态码： 200

可用区信息

{
  "available_zones" : [ {
    "id" : "xxx",
    "az_code" : "xxx",
    "az_name" : "可用区1",
    "az_id" : "xxx",
    "status" : "Running",
    "region_id" : "xxx",
    "az_type" : "Dedicated",
    "az_group_id" : "",
    "az_tags" : {
      "mode" : null,
      "alias" : null,
      "public_border_group" : "center"
    }
  }, {
    "id" : "xxx",
    "az_code" : "xxx",
    "az_name" : "可用区2",
    "az_id" : "xxx",
    "status" : "Running",
    "region_id" : "xxx",
    "az_type" : "Dedicated",
    "az_tags" : {
      "mode" : null,
      "alias" : null,
      "public_border_group" : "center"
    }
  }, {
    "id" : "xxx",
    "az_code" : "xxx",
    "az_name" : "可用区3",
    "az_id" : "xxx",
    "status" : "Running",
    "region_id" : "xxx",
    "az_type" : "Dedicated",
    "az_tags" : {
      "mode" : null,
      "alias" : null,
      "public_border_group" : "center"
    }
  } ],
  "default_az_code" : "xxx",
  "support_physical_az_group" : true
}

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

可用区信息

异常状态码请参见状态码。

错误码

请参见错误码。

父主题： 可用区