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

Querying DR Progress Details

Function

This API is used to query DR progress details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/disaster-recovery/{disaster_recovery_id}/show-progress

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_progress

ClusterDisasterRecovery object

Definition

Cluster DR details.

Range

N/A

Table 3 ClusterDisasterRecovery

Parameter

Type

Description

primary_cluster

ClusterRecoveryProgress object

Definition

DR progress of the primary cluster.

Range

N/A

standby_cluster

ClusterRecoveryProgress object

Definition

DR progress of the DR cluster.

Range

N/A

latest_barrier_time

String

Definition

Fault occurrence time.

Range

N/A

last_recovery_spend

Long

Definition

Time consumed for restoring the previous backup set, in seconds.

Range

N/A

recovery_point_object

Long

Definition

Recovery point objective (RPO), in seconds.

Range

N/A

recovery_time_object

Long

Definition

Recovery time objective (RTO), in seconds.

Range

N/A

Table 4 ClusterRecoveryProgress

Parameter

Type

Description

key

String

Definition

ID of the backup restored in this time.

Range

N/A

action_type

String

Definition

Action type.

Range

N/A

unrestore_keys

String

Definition

ID of the backup set to be restored.

Range

N/A

action_start_time

String

Definition

Start time of the current action.

Range

N/A

action_end_time

String

Definition

End time of the current action.

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Query succeeded.

{
  "disaster_recovery_progress" : {
    "primary_cluster" : {
      "key" : "20230327_201637",
      "action_type" : "Backup",
      "unrestore_keys" : "N/A",
      "action_start_time" : "2023-03-27 20:16:34",
      "action_end_time" : "2023-03-27 20:17:00"
    },
    "standby_cluster" : {
      "key" : "20230327_201637",
      "action_type" : "Restore",
      "unrestore_keys" : "N/A",
      "action_start_time" : "2023-03-27 20:18:27",
      "action_end_time" : "2023-03-27 20:24:40"
    },
    "last_recovery_spend" : 30,
    "latest_barrier_time" : "2023-03-28 10:24:40",
    "recovery_point_object" : 50886,
    "recovery_time_object" : 600
  }
}

Status Codes

Status Code

Description

200

Query 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.