Modifies the backup policy settings of an ApsaraDB RDS instance.
Operation description
Supported engines
ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
ApsaraDB RDS for MariaDB
Related feature documentation
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
rds:ModifyBackupPolicy |
update |
*DBInstance
|
|
None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DBInstanceId |
string |
Yes |
Instance ID of the instance. You can call the DescribeDBInstances operation to query instance ID. |
rm-uf6wjk5**** |
| BackupPolicyMode |
string |
No |
The backup type. Valid values:
|
DataBackupPolicy |
| PreferredBackupTime |
string |
No |
The time period during which the backup task is performed. Specify the time in the HH:mmZ-HH:mmZ format. The time must be in UTC. Note
|
00:00Z-01:00Z |
| PreferredBackupPeriod |
string |
No |
The backup cycle. You must specify at least two days. Separate multiple values with commas (,). Valid values:
Note
|
Monday |
| BackupRetentionPeriod |
string |
No |
The number of days for which data backups are retained. Valid values: 7 to 730. Note
|
7 |
| BackupLog |
string |
No |
Specifies whether to enable log backup. Valid values:
For an ApsaraDB RDS for SQL Server instance, log backup is enabled by default and cannot be disabled. However, you can change the log backup frequency as follows:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. It is used to enable or disable log backup. |
Enable |
| LogBackupRetentionPeriod |
string |
No |
The number of days for which log backups are retained. Valid values: 7 to 730. The value cannot be greater than the number of days for which data backups are retained. Note
|
7 |
| EnableBackupLog |
string |
No |
Specifies whether to enable instance log backup for an ApsaraDB RDS for MySQL, ApsaraDB RDS for PostgreSQL, or ApsaraDB RDS for MariaDB instance. Valid values:
Note
|
1 |
| EnablePitrProtection |
boolean |
No |
Specifies whether to enable point-in-time recovery (PITR) for an ApsaraDB RDS for MySQL instance. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy and BackupLog is set to Enable. For more information, see Configure the point-in-time recovery policy. |
True |
| LocalLogRetentionHours |
string |
No |
The number of hours for which instance log backups are retained locally on the ApsaraDB RDS for MySQL instance. Valid values: 0 to 168 (7 × 24). A value of 0 indicates that log backups are not retained. Note
This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy. In this case, this parameter is required. |
18 |
| LocalLogRetentionSpace |
string |
No |
The maximum usage of the local log circular space for the ApsaraDB RDS for MySQL instance. If the usage exceeds this value, the earliest binary log files are deleted until the usage drops below this value. Valid values: 0 to 50. By default, this parameter is not modified. Note
This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy. In this case, this parameter is required. |
30 |
| HighSpaceUsageProtection |
string |
No |
Specifies whether to unconditionally delete binary log files when the storage usage of the ApsaraDB RDS for MySQL instance exceeds 80% or the remaining storage is less than 5 GB. Valid values: Enable and Disable. By default, this parameter is not modified. Note
This parameter takes effect only when BackupPolicyMode is set to LogBackupPolicy. In this case, this parameter is required. |
Enable |
| LogBackupFrequency |
string |
No |
The log backup frequency for the ApsaraDB RDS for SQL Server instance. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
LogInterval |
| CompressType |
string |
No |
The backup compression method. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
4 |
| ArchiveBackupRetentionPeriod |
string |
No |
The number of days for which archived backups are retained. Default value: 0, which indicates that archive backup is disabled. Valid values: 30 to 1095. Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
365 |
| ArchiveBackupKeepPolicy |
string |
No |
The retention period of archived backups. The number of backups that can be retained within this period is determined by ArchiveBackupKeepCount. Default value: 0. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
ByMonth |
| ArchiveBackupKeepCount |
integer |
No |
The number of archived backups to retain. Default value: 1. Valid values:
Note
|
1 |
| ReleasedKeepPolicy |
string |
No |
The data retention policy for archived backups of a deleted ApsaraDB RDS for MySQL instance. Valid values:
Note
|
None |
| LogBackupLocalRetentionNumber |
integer |
No |
The number of local binary log files to retain. Default value: 60. Valid values: 6 to 100. Note
|
60 |
| Category |
string |
No |
Specifies whether to enable backup within seconds. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
Standard |
| BackupInterval |
string |
No |
The snapshot backup frequency. Valid values:
Note
|
30 |
| BackupMethod |
string |
No |
The backup method for the ApsaraDB RDS for SQL Server instance with cloud disks. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
Physical |
| EnableIncrementDataBackup |
boolean |
No |
Specifies whether to enable incremental backup for an ApsaraDB RDS for SQL Server instance with cloud disks or an ApsaraDB RDS for MySQL instance with local SSDs. Valid values:
Note
This parameter takes effect only when BackupPolicyMode is set to DataBackupPolicy. |
False |
| IncBackupInterval |
integer |
No |
The high-frequency incremental backup frequency for the ApsaraDB RDS for MySQL instance with local SSDs. Valid values:
Note
This parameter takes effect only when EnableIncrementDataBackup is set to True. |
120 |
| BackupPriority |
integer |
No |
The setting for secondary instance backup of an ApsaraDB RDS for SQL Server Cluster Edition instance. Valid values:
Note
|
2 |
| EnableAdvancedBackupPolicy |
integer |
No |
Specifies whether to enable the advanced backup policy. If you set this parameter to 1, both the advanced data backup policy and the advanced log backup policy are configured. |
1 |
| AdvancedDataPolicies |
array<object> |
No |
The list of advanced data backup policies. |
|
|
object |
No |
|||
| ActionType |
string |
No |
The operation on this sub-policy. Valid values:
|
delete/update |
| BakType |
string |
No |
The backup type. Valid values:
|
F |
| DestRegion |
string |
No |
The region ID of the destination region for data backups. |
ap-northeast-1 |
| DestType |
string |
No |
The type of the destination storage pool. Valid values:
|
level1 |
| FilterKey |
string |
No |
The filter option. Valid values:
|
dayOfWeek |
| FilterType |
string |
No |
The filter type. Valid value: crontab, which indicates periodic backup. |
crontab |
| FilterValue |
string |
No |
The filter condition value for data backups. If the filter option is crontab, enter a cron expression.
|
0 2 * * 1-5 |
| OnlyPreserveOneEachDay |
boolean |
No |
Specifies whether to retain only one data backup per day. |
|
| OnlyPreserveOneEachHour |
boolean |
No |
Specifies whether to retain only one data backup per hour. |
|
| RetentionType |
string |
No |
The retention type. Valid values:
|
delay |
| RetentionValue |
integer |
No |
The number of days for which data backups are retained. This parameter takes effect only when RetentionType is set to delay. |
365 |
| SrcRegion |
string |
No |
The region ID of the source region for data backups. |
cn-beijing |
| SrcType |
string |
No |
The type of the source storage pool. |
db |
| StrategyId |
string |
No |
The ID of the sub-backup policy. |
cb875ec7f9809b284f02b88a229061ce |
| AdvancedLogPolicies |
array<object> |
No |
The list of advanced log backup policies. |
|
|
object |
No |
|||
| ActionType |
string |
No |
The operation on this sub-policy. Valid values:
|
update |
| DestRegion |
string |
No |
The region ID of the destination region for log backups. |
ap-northeast-1 |
| DestType |
string |
No |
The type of the destination storage pool. Valid values:
|
level1 |
| EnableLogBackup |
integer |
No |
The flag that indicates whether log backup is enabled. Pass an integer. |
1 |
| FilterKey |
string |
No |
The filter option. Valid values:
|
dayOfWeek |
| FilterValue |
string |
No |
The filter condition value for log backups. If the filter option is crontab, enter a cron expression.
|
0 2 * * 1-5 |
| LogRetentionType |
string |
No |
The log retention type. Valid values:
|
delay |
| LogRetentionValue |
integer |
No |
The number of days for which logs are retained. This parameter takes effect only when LogRetentionType is set to delay. |
7 |
| SrcRegion |
string |
No |
The region ID of the source region for log backups. |
cn-beijing |
| SrcType |
string |
No |
The type of the source storage pool. |
db |
| StrategyId |
string |
No |
The ID of the sub-backup policy. |
cb875ec7f9809b284f02b88a229061ce |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| CompressType |
string |
The backup compression method. Valid values:
|
4 |
| DBInstanceID |
string |
The instance ID. |
rm-uf6wjk5**** |
| EnableBackupLog |
string |
Indicates whether instance log backup is enabled. Valid values:
Note
Log backup is enabled by default and cannot be disabled for ApsaraDB RDS for SQL Server instances. |
1 |
| EnableIncrementDataBackup |
boolean |
Indicates whether incremental backup is enabled. |
|
| EnablePitrProtection |
boolean |
Indicates whether point-in-time recovery (PITR) is enabled for the ApsaraDB RDS for MySQL instance. |
|
| HighSpaceUsageProtection |
string |
Indicates whether binary log files are unconditionally deleted when the storage usage of the ApsaraDB RDS for MySQL instance exceeds 80% or the remaining storage is less than 5 GB. |
Disable |
| IncBackupInterval |
integer |
The high-frequency incremental backup interval. Unit: minutes. Valid values: 60, 120, 240, 360, and 720. |
120 |
| LocalLogRetentionHours |
integer |
The number of hours for which instance log backups are retained locally on the ApsaraDB RDS for MySQL instance. |
18 |
| LocalLogRetentionSpace |
string |
The maximum usage of the binary log loop space for the ApsaraDB RDS for MySQL instance. |
30 |
| LogBackupLocalRetentionNumber |
integer |
The number of local binary log files retained on the ApsaraDB RDS for MySQL instance. |
60 |
| RequestId |
string |
The ID of the request. |
DA147739-AEAD-4417-9089-65E9B1D8240D |
Examples
Success response
JSON format
{
"CompressType": "4",
"DBInstanceID": "rm-uf6wjk5****",
"EnableBackupLog": "1",
"EnableIncrementDataBackup": false,
"EnablePitrProtection": false,
"HighSpaceUsageProtection": "Disable",
"IncBackupInterval": 120,
"LocalLogRetentionHours": 18,
"LocalLogRetentionSpace": "30",
"LogBackupLocalRetentionNumber": 60,
"RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidColdRetention.Format | Invalid cold retention format. | |
| 400 | InvalidLogBackupFrequency.Malformed | Invalid log backup frequency. | The value of the LogBackupFrequency parameter is invalid. Check the value of this parameter. |
| 400 | InvalidBackupRetentionPeriod.Malformed | The specified backup retention period is invalid. | The backup cycle is left unspecified. Specify a backup cycle in the range of 1 day to 30 days. |
| 400 | BackupPropertyNotFound | Backup policy not found | The operation failed. The backup policy cannot be found. |
| 400 | OperationDenied.SwitchToSnapshot | Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode. | Snapshot backups cannot be stored across regions. Disable cross-region backup first and then switch to the snapshot backup mode. |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | Specified Released Keep Policy is not valid. |
| 400 | IncorrectBackupPolicy | The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console. | The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | Your account is not linked to a credit card. |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | No payment method has been specified for your account. We recommend that you add a payment method. |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
| 400 | KmsApiError | User secret key invalid. | The user key is invalid. |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | The required parameters are not provided. |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | Parameter error, please check the parameters. |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | This operation is not supported in the current instance status. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 400 | Pay.NoCreditCard | No credit cards. | No credit cards. |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | The vpc network type instance does not support this operation. |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | Specified DB instance mirror ins already existed. |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | The specified DB instance class stops selling. |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | The specified database does not exist in the backup set. |
| 400 | OrdTCommodityQueryError | Failed to query for product. | Failed to query product. |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | The instance has been released, please verify and place an order. |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | The region is no longer supported. |
| 400 | InvalidDiskType | Current disk type does not support this operation. | The current disk type does not support this operation |
| 400 | InvalidIncrementBackupInterval.Malformed | Parameter 'IncBackupInterval' is invalid. | The IncBackupInterval parameter value is invalid. |
| 400 | InvalidLocalLogRetentionSpace.Malformed | Parameter 'LocalLogRetentionSpace' is invalid. | Parameter 'LocalLogRetentionSpace' is invalid. |
| 400 | InvalidLocalLogRetentionHours.Malformed | Parameter 'LocalLogRetentionHours' is invalid. | Illegal LocalLogRetentionHours parameter setting. |
| 400 | InvalidLogBackupLocalRetentionNumber.Malformed | Parameter 'LogBackupLocalRetentionNumber' is invalid. | Parameter 'LogBackupLocalRetentionNumber' is invalid. |
| 400 | InvalidBackupInterval.Unsupported | BackupInterval can be configured only when Category is set to Standard. The current instance is set to Flash. Please set Category to Standard. | The backup in seconds (Category = Flash) is enabled for the current instance. BackupInterval is supported only when the Category value is Standard. Please set the Category value to Standard, then configure the BackupInterval parameter. |
| 400 | InvalidPitrSetting | Log backup is disabled. Enable PITR requires log backup to be enabled. | Log backup is disabled. If you enable any-point-in-time recovery, log backup must be enabled. |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | The service request failed. Please try again later or contact service personnel. |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | The request failed to be processed due to an RDS API failure. |
| 403 | IncorrectCategory | Current Instance type does not support Category. | The category is not supported for the specified instance type. |
| 403 | OperationDenied.SwitchSnapshotToPhysical | Only physical backup to snapshot backup is supported. | The current operation only supports physical backups to snapshot backups. |
| 403 | OperationDenied.ModifyBackupSwitchOff | The switch is not turned on. It is forbidden to modify the backup mode. | Cross-region backup is not enabled. |
| 403 | OperationDenied.ApiForbiddenForLogBackupFrequency | When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup. | When the instance is in snapshot backup mode, the log backup frequency must not be Same as Data Backup. |
| 403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | If the storage capacity is larger than 4,000 GB, only snapshot backup is supported. |
| 403 | OperationDenied.ApiForbidden | Operation is not permitted. | The operation is not supported. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | This operation is not supported for SSDs. Upgrade to ESSDs. |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | The specified VSwitchId is invalid or empty. |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | There is no available zone for inventory. |
| 403 | NotInFlowController | Sorry,no permission. | Sorry,no permission. |
| 403 | InvalidKmsKey | Kms key is disabled. | The specified KMS key is disabled. |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | The specified database instance type does not support this operation. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | The operation failed because the current instance status does not support this operation. Retry later. |
| 403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time. |
| 403 | Permission.NotSupport | User's permission not support the action. | The data backup and log backup under the current account are restricted by the protection policy. The following operations are not supported: delete the backup, shorten the backup retention time, or reduce the backup frequency. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 404 | Request.NotFound | The requested resource is not available. | The requested resources are unavailable. |
| 404 | HostInfo.NotFound | The specified host info is not found. | The specified host information does not exist. |
| 404 | InvalidInsType.Malformed | Specified instance type is not valid. | The instance type is invalid. |
| 404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
| 408 | NetworkOrSqlTimeoutError | Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later. | The query failed due to timeout caused by potential SQL Server overload or excessive number of instance accounts. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.