Querying AZs¶

Function¶

This API is used to query the AZ information of the current region.

URI¶

GET /v2/available-zones

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 1** Response body parameters¶
Parameter	Type	Description
region_id	String	Region ID.
available_zones	Array of AvailableZones objects	Array of AZs.

**Table 2** AvailableZones¶
Parameter	Type	Description
code	String	AZ code.
port	String	AZ port.
name	String	AZ name.
id	String	AZ ID.
resource_availability	String	Whether the AZ has available resources. true: There are available resources in the AZ. false: No resource is available Enumeration values: true false

Example Requests¶

GET https://{dcs_endpoint}/v2/available-zones

Example Responses¶

Status code: 200

The query is successful.

{
  "region_id" : "region00",
  "available_zones" : [ {
    "code" : "region01",
    "port" : "8403",
    "name" : "AZ 1.",
    "id" : "effdcbc7d4d64a02aa1fa26b42f56533",
    "resource_availability" : "true"
  }, {
    "code" : "region02",
    "port" : "8404",
    "name" : "AZ 2.",
    "id" : "a0865121f83b41cbafce65930a22a6e8",
    "resource_availability" : "true"
  }, {
    "code" : "region03",
    "port" : "8408",
    "name" : "AZ 3.",
    "id" : "2dcb154ac2724a6d92e9bcc859657c1e",
    "resource_availability" : "true"
  } ]
}

Status Codes¶

Status Code	Description
200	The query is successful.

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:54 UTC - commit: 93bd43536502377606412af18143475372cf7df5