Updated on 2025-09-10 GMT+08:00

Querying AZ Information

Function

Querying AZ Information

URI

GET /v2/{project_id}/availability-zone

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID You can obtain the value by calling the IAM API for querying the project list of a specified IAM user.

** Restrictions**:

N/A

Range:

The value is subject to the return value of the IAM service interface. The value contains 32 to 64 characters.

** Default value**:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

** Parameter description**:

User token. You can obtain the token by calling the IAM API used to query the user token. The token is the value of X-Subject-Token in the response header.

** Restrictions**:

N/A

** Value range**:

Used by the IAM service to query the user token.

** Default value**:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

azs

Array of AzInfo objects

AZ set

Table 4 AzInfo

Parameter

Type

Description

zone_name

String

AZ name

zone_number

Integer

AZ ID

az_type

String

AZ Type

alias

String

Chinese alias of the AZ

alias_us

String

English alias of the AZ

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 6 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 8 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

details

Array of DbssErrorDetail objects

PDP5 authentication exception information

encoded_authorization_message

String

PDP5 authentication exception information

error_code

String

Error Codes

error_msg

String

Error message.

Table 10 DbssErrorDetail

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

PDP5 error information

Example Requests

/v2/{project_id}/availability-zone

Example Responses

Status code: 200

Success

{
  "azs" : [ {
    "zone_name" : "cn-north-7b",
    "zone_number" : 2,
    "az_type" : "normal",
    "alias" : "AZ 2",
    "alias_us" : "AZ2"
  }, {
    "zone_name" : "cn-north-7a",
    "zone_number" : 1,
    "az_type" : "normal",
    "alias" : "AZ 1",
    "alias_us" : "AZ1"
  }, {
    "zone_name" : "cn-north-7c",
    "zone_number" : 3,
    "az_type" : "normal",
    "alias" : "AZ 3",
    "alias_us" : "AZ3"
  } ]
}

Status Codes

Status Code

Description

200

Success

400

Client error

403

Authorization failed.

500

Server error.

Error Codes

See Error Codes.