CreateBackup - PolarDB - Alibaba Cloud Documentation Center

Operation description

Note

Each cluster can have up to three manually created backups at a time.
If you receive the error message Exceeding the daily backup times of this DB cluster, this indicates that three manual backups already exist for your cluster. Delete a backup before you call this operation again.
After you call this operation, a backup job is created in the background. The job may take a long time to complete if the data volume is large.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:CreateBackup

create

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-*************
ClientToken	string	No	A client token to ensure the idempotence of the request. The client generates this value, which must be unique among different requests. The token is case-sensitive and cannot exceed 64 ASCII characters.	6000170000591aed949d0f54a343f1a4233c1e7d1c5c******

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F3322AFE-083E-4D77-A074-421301******
BackupJobId	string	The backup job ID.	11111111

Examples

Success response

JSON format

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

Error response

JSON format

{
    "RequestId":"4F780C2E-163A-42C2-9D8A-B5A0C823B1DB"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidBackupType.Malformed	The specified parameter BackupType is not valid.	The specified BackupType parameter is invalid.
400	InvalidBackupMethod.Malformed	The specified parameter BackupMethod is not valid.	The specified BackupMethod parameter is invalid.
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.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.