Help Center/Distributed Cache Service/API Reference/API V2/Other APIs/Querying AZs
Updated on 2025-05-13 GMT+08:00
View PDF

Querying AZs

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v2/available-zones

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

region_id

String

Parameter description:

Region ID.

Value range:

N/A.

available_zones

Array of AvailableZones objects

Parameter description:

Array of AZs.

Value range:

N/A.

Table 2 AvailableZones

Parameter

Type

Description

code

String

Parameter description:

AZ code.

Value range:

N/A.

port

String

Parameter description:

AZ port.

Value range:

N/A.

name

String

Parameter description:

AZ name

Value range:

N/A.

id

String

Parameter description:

AZ ID.

Value range:

N/A.

resource_availability

String

Parameter description:

Whether the AZ has available resources.

Value range:

  • true: There are available resources in the AZ.

  • false: No resource is available.

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.

Parent topic:Other APIs