SetBackupPolicy - PolarDB - Alibaba Cloud Documentation Center

Sets a backup policy.

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

drds:SetBackupPolicy

update

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds************
PreferredBackupPeriod	string	No	The backup cycle. Valid values: 0: Monday 1: Tuesday 2: Wednesday 3: Thursday 4: Friday 5: Saturday 6: Sunday	0
PreferredBackupStartTime	string	No	The start time of the backup.	11:30:30
PreferredBackupEndTime	string	No	The end time of the backup.	12:30:30
BackupMode	string	No	The backup mode. Valid values: logic: logical backup phy: physical backup	phy
BackupLevel	string	No	The backup level. Valid values: db: database level instance: instance level	db
BackupDbNames	string	No	The databases to back up. Separate multiple databases with commas (,). Note This parameter takes effect only when the backup level is set to database level.	test1,test2
BackupLog	string	No	Specifies whether to enable backup logging. Valid values: 1: enabled 0: disabled	1
DataBackupRetentionPeriod	string	No	The number of days for which data backups are retained. Valid values: 7 to 730.	7
LogBackupRetentionPeriod	string	No	The number of days for which log backups are retained. Valid values: 7 to 730. The value must be less than or equal to the data backup retention period.	7

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A3140FC7-B78B-4D8E-B0C8-926D28******
Result	string	Indicates whether the backup policy is set.	success
Success	boolean	The result of the request.	true

Examples

Success response

JSON format

{
  "RequestId": "A3140FC7-B78B-4D8E-B0C8-926D28******",
  "Result": "success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.