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

Switching to the DR Cluster

Function

This API is used to perform a DR switchover.

To perform a switchover when the DR cluster is running properly, you can click Switch to DR Cluster on the console.

You can perform a DR switchover when the DR task is in the Running state.

During a switchover, the original production cluster is not available.

Recovery Point Object (RPO) refers to the point in time to which a system and data must be restored after a disaster occurs. The key aspects are as follows:

Production cluster in the Available state: RPO = 0

Production cluster in the Unavailable state: A zero RPO may not be achieved, but data can at least be restored to that of the latest successful DR synchronization (Last DR Succeeded).

This function is available only for DWS 2.0 clusters.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/disaster-recovery/{disaster_recovery_id}/switchover

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

DisasterRecoveryId object

Definition

DR ID information.

Range

N/A

Table 3 DisasterRecoveryId

Parameter

Type

Description

id

String

Definition

DR ID.

Range

N/A

Example Requests

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/disaster-recovery/e59d6b86-9072-46eb-a996-13f8b44994c1/switchover

Example Responses

Status code: 200

DR switchover task submitted.

{
  "disaster_recovery" : {
    "id" : "e59d6b86-9072-46eb-a996-13f8b44994c1"
  }
}

Status Codes

Status Code

Description

200

DR switchover task submitted.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.