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

Starting a DR Task

Function

This API is used to start a DR task.

The DR task that you want to start must be in the Not started, Startup failed, or Stopped state.

After you start the DR task, you cannot perform some operations, such as restoration, scale-out, upgrade, restart, node replacement, and password update, on the production cluster or DR cluster. Backup is also not allowed on the DR cluster.

After the DR is started, if the DR cluster is running properly and is in the recovery state, the cluster will be billed.

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

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

Example Responses

Status code: 200

Request for starting a DR task submitted.

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

Status Codes

Status Code

Description

200

Request for starting a DR 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.