You can call this operation to manually create full snapshots for an ApsaraDB for PolarDB cluster.

Note
  • You can create up to three manual backups for each cluster. If three manual backups are created, you must delete a backup before manually creating one.
  • After you call this operation, a backup task is created in the background. It may take a long time to back up a large amount 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
DBClusterId String Yes pc-bpxxxxxxx

The ID of the ApsaraDB for PolarDB cluster.

AccessKeyId String No key-test

The AccessKey ID provided to you by Alibaba Cloud.

Action String No CreateBackup

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

Response parameters

Parameter Type Example Description
BackupJobId String 1234567

The ID of the backup set.

RequestId String 4F780C2E-163A-42C2-9D8A-B5A0C823B1DB

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=CreateBackup
&DBClusterId=pc-bpxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<CreateBackupResponse>
  <RequestId>4F780C2E-163A-42C2-9D8A-B5A0C823B1DB</RequestId>
  <BackupJobId>1234567</BackupJobId>
</CreateBackupResponse>

JSON format

{
	"RequestId":"7DD9208D-91C9-4E92-81AE-90B701B6CDD9",
	"BackupJobId":1234567
}

Error codes

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