CreateBackup - PolarDB

Creates a full snapshot backup for a PolarDB cluster.

Operation description

Note

You can manually create up to three backups for each cluster.
The Exceeding the daily backup times of this DB cluster error message indicates that three manual backups already exist in your cluster. You must delete existing backups before you call this operation to manually create backups. For more information about how to delete backups, see Delete 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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
polardb:CreateBackup	Write	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*************
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. The token is case-sensitive.	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F3322AFE-083E-4D77-A074-421301******
BackupJobId	string	The ID of the backup set.	11111111

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	BackupTimesExceeded	The maximum number of backups per day is exceeded.	The number of backups per day for each cluster cannot exceed 3.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-09-12

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change
	delete Error Codes: 403
	Added Error Codes: 400

2022-03-25

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 404 change

2022-03-25

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 404
	Added Error Codes: 403