Updated on 2025-06-20 GMT+08:00

Querying Availability Zones

Function

This API is used to query availability zones.

Call Method

For details, see How to Call an API.

URI

GET /v1.0/availableZones

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameter

Parameter

Type

Description

region_id

String

Indicates the region ID.

available_zones

Array of available_zones objects

Array of AZs.

Table 2 available_zones

Parameter

Type

Description

soldOut

Boolean

Indicates whether resources are sold out.

id

String

Indicates the ID of an AZ.

code

String

Indicates the code of an AZ.

name

String

Indicates the name of an AZ.

port

String

Indicates the port number of an AZ.

resource_availability

String

Indicates whether an AZ has available resources.

default_az

Boolean

Whether the AZ is the default AZ.

remain_time

Long

Remaining time.

ipv6_enable

Boolean

Whether IPv6 is supported.

Example Requests

GET https://{endpoint}/v1.0/availableZones

Example Response

Status code: 200

Metrics queried successfully.

{
  "region_id" : "xxx",
  "available_zones" : [ {
    "soldOut" : false,
    "id" : "8c90c2a4e2594c0782faa6b205afeca7",
    "code" : "xxx",
    "name" : "AZ 1",
    "port" : "8002",
    "resource_availability" : "true",
    "default_az" : false,
    "remain_time" : 9223372036854776000,
    "ipv6_enable" : false
  }, {
    "soldOut" : false,
    "id" : "d539378ec1314c85b76fefa3f7071458",
    "code" : "xxx",
    "name" : "AZ 2",
    "port" : "8003",
    "resource_availability" : "true",
    "default_az" : false,
    "remain_time" : 9223372036854776000,
    "ipv6_enable" : false
  }, {
    "soldOut" : false,
    "id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
    "code" : "xxx",
    "name" : "AZ 3",
    "port" : "443",
    "resource_availability" : "true",
    "default_az" : true,
    "remain_time" : 9223372036854776000,
    "ipv6_enable" : false
  } ]
}

Status Code

Status Code

Description

200

Successful

Error Code

See Error Codes.