Help Center/ Distributed Cache Service/ API Reference/ Out-of-Date APIs (Unavailable Soon)/ Other APIs/ Querying AZ Information
Updated on 2024-03-05 GMT+08:00
View PDF
Share

Querying AZ Information

Function

This API is used to query the ID of the AZ where a DCS instance resides. For example, to create a DCS instance in an AZ with available resources in the CN North-Beijing1 region, locate the record in the response message in which the value of resource_availability is true. Then, the value of id in the same record indicates the ID of the AZ where the instance resides.

URI

GET /v1.0/availableZones

Request

Request parameters

None.

Example request

None.

Response

Response parameters

Table 1 describes the response parameters.
Table 1 Parameter description

Parameter

Type

Description

regionId

String

Region ID.

available_zones

Array

Array of AZs. For details, see Table 2.
Table 2 Parameter description of the available_zones array

Parameter

Type

Description

id

String

AZ ID.

code

String

AZ code.

name

String

AZ name.

port

String

Port number of the AZ.

resource_availability

String

An indicator of whether there are available resources in the AZ.

  • true: There are available resources in the AZ.
  • false: All resources have been used up in the AZ.

Example response

{
    "regionId": "XXXXXX",
    "available_zones": [
        {
            "id": "f84448fd537f46078dd8bd776747f573",
            "code": "XXXXXX",
            "name": "XXXXXX",
            "port": "8003",
            "resource_availability": "true"
        },
        {
            "id": "12c47a78666b4e438cd0c692b9860387",
            "code": "XXXXXX",
            "name": "XXXXXX",
            "port": "8002",
            "resource_availability": "true"
        },
        {
            "id": "0725858e0d26434f9aa3dc5fc40d5697",
            "code": "XXXXXX",
            "name": "XXXXXX",
            "port": "8009",
            "resource_availability": "true"
        }
    ]
}

Status Code

Table 3 describes the status code of successful operations. For details about other status codes, see Table 1.

Table 3 Status code

Status Code

Description

200

AZ information queried successfully.
Parent Topic: Other APIs