Creates a full snapshot backup for a specified PolarDB cluster.

Note
  • You can manually create up to three backups for each cluster.
  • The error message Exceeding the daily backup times of this DB cluster indicates that three manual backups already exist in your cluster. You must delete a backup before you call this operation to manually create backups.
  • After you call this operation, a backup task is created in the backend. The task may be time-consuming if you want to back up large amounts of data.

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 No CreateBackup

The operation that you want to perform. Set the value to CreateBackup.

DBClusterId String Yes pc-*************

The ID of the cluster.
ClientToken String No 6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

The client token that is used to ensure the idempotency of requests. If an API operation is idempotent, the API operation returns the same result for identical requests. You can use the client to generate the value. Make sure that the value is unique for different requests. The token is case-sensitive. It can contain only ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter Type Example Description
BackupJobId String 11111111

The ID of the backup set.
RequestId String F3322AFE-083E-4D77-A074-421301******

The ID of the request.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/? Action=CreateBackup
&DBClusterId=pc-*************
&<Common request parameters>

Sample success responses

XML format 

<CreateBackupResponse>
  <RequestId>F3322AFE-083E-4D77-A074-421301******</RequestId>
  <BackupJobId>11111111</BackupJobId>
</CreateBackupResponse>

JSON format 

{
	"RequestId": "F3322AFE-083E-4D77-A074-421301******",
	"BackupJobId": 11111111
}

Error codes

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