Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ AZ Query/ Querying All AZs
Updated on 2024-02-27 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.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

availabilityZoneInfo

Array of AzInfo objects

The returned list of AZs.
Table 4 AzInfo

Parameter

Type

Description

zoneName

String

The AZ name.

zoneState

ZoneState object

The AZ status.
Table 5 ZoneState

Parameter

Type

Description

available

Boolean

Whether the AZ is available.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 7 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

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

Example Responses

Status code: 200

AZ information returned.

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

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

200

AZ information returned.

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: AZ Query