Help Center/ Elastic Volume Service/ API Reference/ API/ AZ Query/ Querying All AZs
Updated on 2025-11-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying All AZs

Function

This API is used to query all AZs.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/os-availability-zone

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

availabilityZoneInfo

Array of AzInfo objects

Definition

The list of returned AZs.

Range

N/A
Table 4 AzInfo

Parameter

Type

Description

zoneName

String

Definition

The AZ name.

Range

N/A

zoneState

ZoneState object

Definition

The AZ status.

Range

N/A
Table 5 ZoneState

Parameter

Type

Description

available

Boolean

Definition

Whether the AZ is available.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 7 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

GET https://{endpoint}/v2/{project_id}/os-availability-zone

Example Responses

Status code: 200

OK

{
  "availabilityZoneInfo" : [ {
    "zoneState" : {
      "available" : true
    },
    "zoneName" : "az-dc-1"
  } ]
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "EVS.XXX"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent topic: AZ Query