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

Creating a DR Task

Function

This API is used to create a DR task.

You can create a DR task only when the cluster is in the Available or Unbalanced state.

This function is available only for DWS 2.0 clusters.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/disaster-recoveries

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

disaster_recovery

Yes

CreateDisasterRecovery object

Definition

DR information.

Range

N/A

Table 3 CreateDisasterRecovery

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Name.

Range

N/A

dr_type

Yes

String

Definition

DR type.

Range

N/A

primary_cluster_id

Yes

String

Definition

ID of the primary cluster.

Range

N/A

standby_cluster_id

Yes

String

Definition

ID of the DR cluster.

Range

N/A

dr_sync_period

Yes

String

Definition

Synchronization period.

Range

N/A

primary_obs_bucket

No

String

Definition

OBS bucket of the primary cluster.

Range

N/A

standby_obs_bucket

No

String

Definition

OBS bucket of the DR cluster.

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

Create a cross-AZ DR task (Task name: test_dr4. Data synchronization interval: 5 minutes. Primary cluster ID: 3ef5daaa-d017-4354-80b3-8a69caf2e09. DR cluster ID: e7fed7fe-f4a7-499a-afed-1fdb5c1978cb).

POST https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/disaster-recoveries

Example Responses

Status code: 200

DR task created.

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

Status Codes

Status Code

Description

200

DR task created.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.