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

Querying the List of Available DR Clusters

Function

This API is used to query the list of available DR clusters.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/disaster-recovery-clusters

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

primary_cluster_id

Yes

String

Definition

ID of the primary cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

standby_az_code

Yes

String

Definition

AZ where the DR cluster is located.

Constraints

N/A

Range

N/A

Default Value

N/A

primary_spec_id

No

String

Definition

Flavor ID of the primary cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

primary_cluster_dn_num

No

String

Definition

Number of DNs in the primary cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

standby_region

No

String

Definition

Region where the DR cluster is located.

Constraints

N/A

Range

N/A

Default Value

N/A

standby_project_id

No

String

Definition

Project ID of the DR cluster.

Constraints

N/A

Range

N/A

Default Value

N/A

dr_type

No

String

Definition

DR type.

Constraints

N/A

Range

N/A

Default Value

N/A

datastore_type

No

String

Definition

Data warehouse type.

Constraints

N/A

Range

N/A

Default Value

N/A

datastore_version

No

String

Definition

Data warehouse version.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

disaster_recovery_clusters

Array of DisasterRecoveryClusterVo objects

Definition

Available clusters for DR.

Range

N/A

Table 4 DisasterRecoveryClusterVo

Parameter

Type

Description

id

String

Definition

Cluster ID.

Range

It is a 36-digit UUID.

name

String

Definition

Cluster name.

Range

N/A

Example Requests

https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery-clusters?primaryClusterId=3de21046-e65e-4fcf-86bf-583115b39c27&standbyAZCode=cn-north-7a&standbyRegion=&drType=&standbyProjectId=

Example Responses

Status code: 200

Request succeeded.

{
  "disaster_recovery_clusters" : [ ]
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.