Updated on 2022-09-15 GMT+08:00

Querying AZ Information

This API is out-of-date and may not be maintained in the future. Please use the API described in Listing AZ Information.

Function

This API is used to query the AZ ID.

URI

GET /v1.0/availableZones

Request

Request parameters

None.

Example request

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

Response

Response parameters

Table 1 and Table 2 describe the parameters.

Table 1 Response parameters

Parameter

Type

Description

region_id

String

Indicates the region ID.

available_zones

Array

Indicates details of AZs. For details, see Table 2.

Table 2 available_zones parameter description

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.

  • true: The AZ has available resources.
  • false: Resources of the AZ have been sold out.

Example response

{  
    regionId: "XXXX",  
    available_zones:[  
       {  
            "id":"1d7b939b382c4c3bb3481a8ca10da768",  
            "name":"az10.dc1",  
            "code":"az10.dc1",  
            "port":"8002", 
            "resource_availability": "true" 
        },    
        {  
            "id":"1d7b939b382c4c3bb3481a8ca10da769",  
            "name":"az10.dc2",  
            "code":"az10.dc2",  
            "port":"8002", 
            "resource_availability": "true" 
        }  
    ]  
}

Status Code

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

Table 3 Status code

Status Code

Description

200

The AZ information is successfully queried.