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

Modifying DR Configurations

Function

This API is used to modify DR configurations.

Only DR tasks in the Not started or Stopped state can be modified.

The new configurations are applied t after the DR task is restarted.

Calling Method

For details, see Calling APIs.

URI

PUT /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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

disaster_recovery

No

UpdateDisasterRecoveryReq object

Definition

DR configurations.

Range

N/A

Table 3 UpdateDisasterRecoveryReq

Parameter

Mandatory

Type

Description

dr_sync_period

No

String

Definition

DR synchronization period.

Range

N/A

send_request

No

Integer

Definition

Whether to send a request.

Range

N/A

primary_to_role

No

String

Definition

Role of the primary cluster.

Range

N/A

reset_action

No

String

Definition

DR action.

Range

N/A

standby_to_role

No

String

Definition

Role of the DR cluster.

Range

N/A

dr_status

No

String

Definition

DR status.

Range

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

disaster_recovery

DisasterRecoveryId object

Definition

DR ID information.

Range

N/A

Table 5 DisasterRecoveryId

Parameter

Type

Description

id

String

Definition

DR ID.

Range

N/A

Example Requests

Change the cluster DR synchronization period to 3 hours, the primary cluster to primary, the DR cluster to standby, and the DR action to DR_RUNNING.

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

{
  "disaster_recovery" : {
    "dr_sync_period" : "3H",
    "send_request" : 0,
    "primary_to_role" : "primary",
    "standby_to_role" : "standby",
    "reset_action" : "DR_RUNNING",
    "dr_status" : "running"
  }
}

Example Responses

Status code: 200

DR configurations modified.

{
  "disaster_recovery" : {
    "id" : "xxxx"
  }
}

Status Codes

Status Code

Description

200

DR configurations modified.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.