Querying AZs

Function

This API is used to query AZs.

URI

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

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

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

Response

Table 2 describes the response parameters.

Table 2 Response parameters

Parameter

Type

Description

availabilityZoneInfo

Array of objects

Specifies the AZ information. For details, see Table 3.
Table 3 AvailabilityZoneInfo parameter information

Parameter

Type

Description

zoneState

Object

Specifies the AZ status. For details, see Table 4.

hosts

List

The parameter is set to null.

zoneName

String

Specifies the AZ name.
Table 4 zoneState parameter information

Parameter

Type

Description

available

Boolean

Specifies the AZ status.

Example Request

GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone

Example Response

{
	"availabilityZoneInfo": [{
		"zoneState": {
			"available": true
		},
		"hosts": null,
		"zoneName": "az1"   //Replace the value with the actual AZ name.
	},
	{
		"zoneState": {
			"available": true
		},
		"hosts": null,
		"zoneName": "az2"   //Replace the value with the actual AZ name.
	}]
}

Returned Values

See Returned Values for General Requests.

Parent topic: AZ