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

Performing an Exception Switchover

Function

This API is used to perform an primary/standby switchover when a DR exception occurs.

To perform a switchover when the DR cluster is abnormal or the production cluster is faulty, you can click Exception Switchover on the console.

DR exception switchover is supported only by clusters of version 8.1.2 or later.

Before a switchover, check the latest synchronization time in the DR cluster. The DR cluster will serve as a production cluster after a switchover, but the data that failed to be synchronized from the original production cluster to the DR cluster will not exist in the DR cluster.

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}/failover

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

Example Responses

Status code: 200

Exception switchover submitted.

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

Status Codes

Status Code

Description

200

Exception switchover 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.