Use the ModifyBackupPolicy API to modify an automatic backup policy - PolarDB - Alibaba Cloud - PolarDB

Modifies the automatic backup policy of a PolarDB cluster.

Operation description

Note

You can also modify the automatic backup policy of a PolarDB cluster in the console. For more information, see Backup settings.

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:ModifyBackupPolicy

update

*dbcluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query information about all clusters in a specific region, including cluster IDs.	pc-bp13wz9586voc****
PreferredBackupTime	string	No	The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`.	15:00Z-16:00Z
PreferredBackupPeriod	string	No	The backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note Select at least 2 days. Separate multiple values with commas (,). If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	Monday,Tuesday
DataLevel1BackupRetentionPeriod	string	No	The retention period of level-1 backups. Valid values: 3 to 14. Unit: days. Note After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	3
DataLevel2BackupRetentionPeriod	string	No	The retention period of level-2 backups. Valid values: 0: Disables the level-2 backup feature. 30 to 7300: The retention period of level-2 backups. Unit: days. -1: Long-term retention (LTR) of level-2 backups. Note When a cluster is created, the default value is 0, which means the level-2 backup feature is disabled. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	0
BackupRetentionPolicyOnClusterDeletion	string	No	Specifies whether to retain backups when the cluster is deleted. Valid values: ALL: Long-term retention (LTR) of all backups. LATEST: Long-term retention (LTR) of only the last backup. NONE: Does not retain any backups. Note Default value: NONE.	NONE
BackupFrequency	string	No	The backup frequency. Valid values: Normal (default): regular backup. Automatic backup is performed once a day at a scheduled time. 2/24H: high-frequency backup. Backup is performed every 2 hours. 3/24H: high-frequency backup. Backup is performed every 3 hours. 4/24H: high-frequency backup. Backup is performed every 4 hours. Note After high-frequency backup is enabled, all backups completed within 24 hours are retained. For backups older than 24 hours, only the first backup completed after 00:00 each day is retained, and all others are deleted. After high-frequency backup is enabled, the backup cycle parameter PreferredBackupPeriod defaults to all days of the week (Monday through Sunday). If the region of your PolarDB for MySQL cluster supports the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	Normal
DataLevel1BackupFrequency	string	No	The backup frequency. Valid values: Normal (default): regular backup. Automatic backup is performed once a day at a scheduled time. 2/24H: high-frequency backup. Backup is performed every 2 hours. 3/24H: high-frequency backup. Backup is performed every 3 hours. 4/24H: high-frequency backup. Backup is performed every 4 hours. Note PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	Normal
DataLevel1BackupTime	string	No	The time period during which automatic backup is performed. Specify the time period in the `hh:mmZ-hh:mmZ` format in UTC. The values must be on the hour with an interval of 1 hour, such as `14:00Z-15:00Z`. Note PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview.	15:00Z-16:00Z
DataLevel1BackupPeriod	string	No	The level-1 backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note Select at least 2 days. Separate multiple values with commas (,). PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	Monday,Tuesday
DataLevel2BackupPeriod	string	No	The level-2 backup cycle. Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note Select at least 2 days. Separate multiple values with commas (,). PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. If the region of your PolarDB for MySQL cluster does not support the cross-region backup feature, this parameter is not supported. For regions that support cross-region backup, see Overview. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	Monday,Tuesday
DataLevel2BackupAnotherRegionRegion	string	No	The destination region for cross-region level-2 backups. For regions that support cross-region backup, see Overview. Note After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	cn-hangzhou
DataLevel2BackupAnotherRegionRetentionPeriod	string	No	The retention period of cross-region backups for level-2 backups. Valid values: 0: Disables the level-2 cross-region backup feature. 30 to 7300: The retention period of level-2 backups. Unit: days. -1: Long-term retention (LTR) of level-2 backups. Note When a cluster is created, the default value is 0, which means the level-2 cross-region backup feature is disabled. After advanced backup is enabled, this parameter no longer takes effect. Use the AdvancedDataPolicies parameter instead.	30
BackupPolicyLevel	string	No	The backup policy level. Valid values: Normal: regular backup. Advanced: advanced backup. Note PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. You can check the AdvancedPolicyOption response parameter of the DescribeBackupPolicy operation to determine whether the cluster supports advanced backup. If the cluster supports advanced backup, you can apply to use this feature through Advanced backup settings. After advanced backup is enabled, rollback to regular backup is not supported.	Normal
AdvancedDataPolicies	array<object>	No	The advanced backup policy. Note PolarDB for PostgreSQL (Compatible with Oracle) and PolarDB for PostgreSQL do not support this parameter. Only clusters with BackupPolicyLevel set to Advanced support this parameter.
	object	No
ActionType	string	No	The action type. Valid values: CREATE: create UPDATE: update DELETE: delete	CREATE
AutoCreated	boolean	No	Indicates whether the backup policy is automatically generated by the system. Note This parameter value is automatically generated. You do not need to specify it.	false
BakType	string	No	The backup type. Valid values: F: full backup. Note This parameter cannot be modified and is fixed to F.	F
DestRegion	string	No	The destination region of the backup policy.	cn-beijing
DestType	string	No	The destination type of the backup policy. Valid values: level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level2
DumpAction	string	No	The method for converting level-1 backups to level-2 backups. Valid values: copy: copy	copy
FilterKey	string	No	The scheduling type. Valid values: dayOfWeek: scheduled by week dayOfMonth: scheduled by month dayOfYear: scheduled by year backupInterval: scheduled at fixed intervals Note This parameter is required only when FilterType is set to crontab.	dayOfWeek
FilterType	string	No	The filter type of the advanced policy. Valid values: crontab: periodic scheduling event: event-based scheduling	crontab
FilterValue	string	No	The backup cycle.	1,2,3,4,5,6,7
OnlyPreserveOneEachDay	boolean	No	The 24-hour backup data retention policy. Valid values: true: Only the first backup set of the day is retained for backups older than 24 hours. false: All backup sets are retained.	true
OnlyPreserveOneEachHour	boolean	No	The hourly backup data retention policy. Valid values: true: Only the earliest backup set within each hour is retained for backups older than 1 hour. false: All backup sets are retained. Note This parameter cannot be modified and is fixed to true.	true
PolicyId	string	No	The backup policy ID. You can call the DescribeBackupPolicy operation to query the backup policy ID.	71930ac2e9f15e41615e10627c******
RetentionType	string	No	The retention type of backup sets. Valid values: never: never expires delay: expires after a fixed number of days	delay
RetentionValue	string	No	The number of days to retain backups.	7
SrcRegion	string	No	The source region of the backup policy.	cn-shanghai
SrcType	string	No	The source type of the backup policy. Valid values: db: database cluster level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
StorageClass	string	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C5A5DF0E-5968-4DC1-882E-AC2FE7******

Examples

Success response

JSON format

{
  "RequestId": "C5A5DF0E-5968-4DC1-882E-AC2FE7******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDataLevel1BackupRetentionPeriod.Malformed	The specified parameter DataLevel1BackupRetentionPeriod is not valid.	The specified DataLevel1BackupRetentionPeriod parameter is invalid.
400	InvalidDataLevel2BackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupRetentionPeriod is not valid.	The specified DataLevel2BackupRetentionPeriod parameter is invalid.
400	InvalidBackupRetentionPeriod.Malformed	The specified parameter BackupRetentionPeriod is not valid.	The specified BackupRetentionPeriod parameter is invalid.
400	InvalidBackupFrequency.Malformed	The specified parameter BackupFrequency is not valid.	The specified BackupFrequency parameter is invalid.
400	InvalidPreferredBackupPeriod.Malformed	The specified parameter PreferredBackupPeriod is not valid.	The specified PreferredBackupPeriod parameter is invalid.
400	InvalidDataLevel2BackupPeriod.Malformed	The specified parameter DataLevel2BackupPeriod is not valid.	The specified DataLevel2BackupPeriod parameter is invalid.
400	InvalidDataLevel1BackupPeriod.Malformed	The specified parameter DataLevel1BackupPeriod is not valid.	The specified DataLevel1BackupPeriod parameter is invalid.
400	InvalidPreferredBackupTime.Malformed	The specified parameter PreferredBackupTime is not valid.	The specified PreferredBackupTime parameter is invalid.
400	InvalidDataLevel1BackupTime.Malformed	The specified parameter DataLevel1BackupTime is not valid.	The specified DataLevel1BackupTime parameter is invalid.
400	InvalidDataLevel1BackupFrequency.Malformed	The specified parameter DataLevel1BackupFrequency is not valid.	The specified DataLevel1BackupFrequency parameter is invalid.
400	InvalidDataLevel2AnotherRegionRegion.NotFound	The specified parameter DataLevel2BackupAnotherRegionRegion does not found.	The specified DataLevel2BackupAnotherRegionRegion parameter cannot be found.
400	InvalidDataLevel2AnotherRegionBackupRetentionPeriod.Malformed	The specified parameter DataLevel2BackupAnotherRegionRetentionPeriod is not valid.	The specified DataLevel2BackupAnotherRegionRetentionPeriod parameter is invalid.
403	IncorrectBackupPolicy	Current DB type does not support low frequency backupPolicy operation.	Infrequent access backup operations are not supported by the current database type.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidParam	new archiveBackup policy already exists. dumpretention parameter cannot used alone	An archive backup policy has been created. The dumpretation parameter cannot be used alone.
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.