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

Querying DR Details

Function

This API is used to query details about a DR task.

Calling Method

For details, see Calling APIs.

URI

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

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

disaster_recovery_id

Yes

String

Definition

DR ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

disaster_recovery

DisasterRecoveryQueryResp object

Definition

Response body for querying DR information.

Range

N/A

Table 3 DisasterRecoveryQueryResp

Parameter

Type

Description

id

String

Definition

DR ID.

Range

N/A

name

String

Definition

DR name.

Range

N/A

dr_type

String

Definition

DR type.

Range

N/A

status

String

Definition

DR status.

Range

N/A

primary_cluster

DisasterRecoveryCluster object

Definition

Primary cluster information.

Range

N/A

standby_cluster

DisasterRecoveryCluster object

Definition

DR cluster information.

Range

N/A

dr_sync_period

String

Definition

DR synchronization period.

Range

N/A

start_time

String

Definition

DR start time.

Range

N/A

create_time

String

Definition

DR creation time.

Range

N/A

Table 4 DisasterRecoveryCluster

Parameter

Type

Description

id

String

Definition

ID of the DR cluster.

Range

N/A

name

String

Definition

Name of the DR cluster.

Range

N/A

cluster_az

String

Definition

AZ where the DR cluster is located.

Range

N/A

role

String

Definition

Role of the DR cluster.

Range

N/A

region

String

Definition

Region where the DR cluster is located.

Range

N/A

status

String

Definition

Status of the DR cluster.

Range

N/A

progress

String

Definition

DR progress.

Range

N/A

last_success_time

String

Definition

Last DR time.

Range

N/A

obs_bucket_name

String

Definition

OBS bucket name.

Range

N/A

Example Requests

https://{Endpoint}/v2/0536cdee2200d5912f7cc00b877980f1/disaster-recovery/b303b78d-438c-41dd-aaf6-c98eea1fc2a6

Example Responses

Status code: 200

DR information queried.

{
  "disaster_recovery" : {
    "id" : "b303b78d-438c-41dd-aaf6-c98eea1fc2a6",
    "name" : "dws-it-02",
    "status" : "running",
    "dr_type" : "region",
    "primary_cluster" : {
      "id" : "3de21046-e65e-4fcf-86bf-583115b39c27",
      "name" : "dws-203-primary",
      "cluster_az" : "cn-north-7c",
      "role" : "primary",
      "region" : "cn-north-7",
      "status" : "waiting",
      "progress" : "100",
      "last_success_time" : "2023-04-29T06:39:56",
      "obs_bucket_name" : null
    },
    "standby_cluster" : {
      "id" : "5d946c51-9ffa-49e3-9129-2bea4d23d3fd",
      "name" : "dws-205-standby",
      "cluster_az" : null,
      "role" : "standby",
      "region" : "cn-north-208",
      "status" : "waiting",
      "progress" : "100",
      "last_success_time" : "2023-04-29T06:39:56",
      "obs_bucket_name" : null
    },
    "dr_sync_period" : "3H",
    "start_time" : "2023-04-28T09:23:38",
    "create_time" : "2023-04-28T08:51:54"
  }
}

Status Codes

Status Code

Description

200

DR information queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.