Querying AZ Information

Function

This API is used to query the availability zone (AZ) ID used when you create a cluster.

URI

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

Table 1 URI parameters
Parameter	Mandatory	Type	Description
region_id	Yes	String	Region ID

Table 2 Query parameters
Parameter	Mandatory	Type	Description
scope	No	String	AZ range. The options are as follows: Center Edge

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameter
Parameter	Type	Description
available_zones	Array of AvailableZoneV2 objects	AZ list. For details about AvailableZoneV2, see Table 4.
default_az_code	String	Default AZ code
support_physical_az_group	Boolean	Supported physical AZ group

Table 4 AvailableZoneV2
Parameter	Type	Description
id	String	AZ ID
az_code	String	AZ code
az_name	String	AZ name
az_id	String	AZ ID
status	String	AZ status
region_id	String	Region ID
az_group_id	String	AZ group ID
az_type	String	AZ type Core Satellite Dedicated Virtual Edge EdgeCental: central and edge
az_tags	AvailableTag object	AZ tag. For details about AvailableTag, see Table 5.

Table 5 AvailableTag
Parameter	Type	Description
mode	String	AZ mode. The value can be dedicated or shared.
alias	String	Alias of an AZ
public_border_group	String	Group to which the AZ belongs. The default value is center.

Example Request

None

Example Response

Status code: 200

Query AZ information.

{
  "available_zones" : [ {
    "id" : "xxx",
    "az_code" : "xxx",
    "az_name" : "AZ 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" : "AZ 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" : "AZ 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
}

Status Code

See Table 6.

Table 6 Status Code
Status Code	Description
200	AZ information

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Availability Zones

Была ли эта статья полезна?

Поддержка Юридические документы