更新时间:2023-10-16 GMT+08:00

查询可用区信息

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

region_id

String

区域ID。

表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

支持的物理可用区分组。

表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

当前AZ的类型:

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

az_tags

AvailableTag object

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

表5 AvailableTag

参数

参数类型

描述

mode

String

可用区模式,分为专属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

可用区信息

异常状态码请参见状态码

错误码

请参见错误码