Help Center/ DataArts Studio/ More Documents/ API Reference (Ally Region)/ DataArts Migration APIs/ Cluster Management/ Querying All AZs
Updated on 2026-01-30 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying All AZs

Function

This API is used to query all AZs of a CDM cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.1/{project_id}/regions/{region_id}/availability_zones

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

region_id

Yes

String

Region ID. You can obtain it from the response message of the "Querying the Region List" API of the IAM service.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

regionId

String

Region ID.

defaultAZ

String

Specifies the default AZ.

availableZones

Array of CdmClusterAvailabilityZone objects

Indicates the AZ.
Table 4 CdmClusterAvailabilityZone

Parameter

Type

Description

availableZoneId

String

ID of the AZ

availableZoneName

String

AZ name

availableZoneCode

String

Indicates the AZ code.

azStatus

String

AZ status.

type

String

Indicates the AZ type.

tags

Object

AZ tag

Example Requests

GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/regions/xxx-xxx-xxx/availability_zones

Example Responses

Status code: 200

The request is successful.

{
  "regionId" : "xxx-xxx-xxx",
  "defaultAZ" : "xxx-xxx-xxx",
  "availableZones" : [ {
    "availableZoneId" : "xxx-xxx-xxx",
    "availableZoneName" : "xxx-xxx-xxx",
    "availableZoneCode" : "xxx-xxx-xxx",
    "azStatus" : "Available",
    "type" : null,
    "tags" : null
  } ]
}

Status Codes

Status Code

Description

200

The request is successful.

400

Request error.

401

Authentication failed.

403

No operation permission.

404

No resources found.

500

Internal service error. For details about the returned error code, see Error Codes.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Cluster Management