Creates a full snapshot backup for a specified PolarDB cluster.

Note
  • You can create a maximum of three backups for each cluster. If three manual backups are created, you must delete at least one backup before you manually create one. For more information, see DeleteBackup.
  • After you call this operation, a backup task is created in the background. It may take a long time 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 PolarDB cluster.

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.