You can call this operation to create a backup plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBackupPlan

The operation that you want to perform. Set the value to CreateBackupPlan.
BackupTime String Yes 00:30Z

The start time of the backup task each day. The time is displayed in UTC and denoted by Z.

ClusterId String Yes cds-bp11tjzh50****7b

The ID of the cluster for the backup.
DataCenterId String Yes cn-hangzhou-g

The ID of the data center for the backup in the cluster.
BackupPeriod String No Monday

The backup cycle. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday.

RetentionPeriod Integer No 5

The duration for which you want to retain the backup. Valid values: 1 to 7. Unit: days.

Active Boolean No true

Specifies whether to activate the backup plan.

Response parameters

Parameter Type Example Description
RequestId String 200FB963-9359-4CAD-90B7-96395C88FD9D

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=CreateBackupPlan
&BackupTime=00:30Z
&ClusterId=cds-bp11tjzh50****7b
&DataCenterId= cn-hangzhou-g
&<Common request parameters>

Sample success responses

XML format 

<CreateBackupPlanResponse>
      <RequestId>200FB963-9359-4CAD-90B7-96395C88FD9D</RequestId>
</CreateBackupPlanResponse>

JSON format 

{
    "RequestId": "200FB963-9359-4CAD-90B7-96395C88FD9D"
}

Error codes

For a list of error codes, visit the API Error Center.