You can call the ModifyBackupPolicy operation to modify the backup settings of an ApsaraDB RDS instance.
Before you call this operation, make sure that the following requirements are met:
- The instance must not be a read-only instance.
- The instance must be in the Running state.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ModifyBackupPolicy |
The operation that you want to perform. Set the value to ModifyBackupPolicy. |
DBInstanceId | String | Yes | rm-uf6wjk5xxxxxxx |
The ID of the instance. You can call the DescribeDBInstances operation to query the IDs of instances. |
BackupPolicyMode | String | No | DataBackupPolicy |
The type of backup that you want to perform. Valid values:
|
PreferredBackupTime | String | No | 00:00Z-01:00Z |
The time at which you want to perform a backup. Specify the time in the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time must be in UTC. Note
|
PreferredBackupPeriod | String | No | Monday |
The cycle based on which you want to perform a backup. Specify at least two days of the week and separate the days with commas (,). Valid values:
Note
|
BackupRetentionPeriod | String | No | 7 |
The number of days for which you want to retain data backup files. Valid values: 7 to 730. Note
|
BackupLog | String | No | Enable |
Specifies whether to enable the log backup feature. Valid values:
Note
|
LogBackupRetentionPeriod | String | No | 7 |
The number of days for which you want to retain log backup files. Valid values: 7 to 730. The log backup retention period cannot be longer than the data backup retention period. Note
|
EnableBackupLog | String | No | 1 |
Specifies whether to enable the log backup feature. Valid values:
Note
|
LocalLogRetentionHours | String | No | 18 |
The number of hours for which you want to retain log backup files on the instance. Valid values: 0 to 7 × 24. The value 0 specifies that log backup files are not retained on the instance. Note
|
LocalLogRetentionSpace | String | No | 30 |
The maximum storage usage that is allowed for log backup files on the instance. If the storage usage for log backup files on the instance exceeds the value of this parameter, ApsaraDB RDS deletes earlier log backup files until the storage usage falls below the value of this parameter. Valid values: 0 to 50. If you do not specify this parameter, the existing value of this parameter is retained. Note
|
HighSpaceUsageProtection | String | No | Enable |
Specifies whether ApsaraDB RDS forcibly deletes log backup files from the instance when the storage usage of the instance exceeds 80% or the amount of remaining storage on the instance is less than 5 GB. Valid values: Enable and Disable. If you do not specify this parameter, the existing value of this parameter is retained. Note
|
LogBackupFrequency | String | No | LogInterval |
The frequency at which you want to back up the binary logs of the instance. Valid values:
Note
|
CompressType | String | No | 4 |
The format into which backup files are compressed. Valid values:
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
|
ArchiveBackupRetentionPeriod | String | No | 365 |
The number of days for which you want to retain archived backup files. The default value 0 specifies that the backup archiving feature is not enabled. Valid values: 30 to 1095. Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
|
ArchiveBackupKeepPolicy | String | No | ByMonth |
The unit that is used to measure the period of time for which you want to retain archived backup files. The number of archived backup files that can be retained within the specified retention period is specified by the ArchiveBackupKeepCount parameter. Default value: 0. Valid values:
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
|
ArchiveBackupKeepCount | Integer | No | 1 |
The number of archived backup files that you want to retain. Default value: 1. Valid values:
Note
|
ReleasedKeepPolicy | String | No | None |
The policy based on which ApsaraDB RDS retains archived backup files if the instance is released. Default value: None. Valid values:
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
|
LogBackupLocalRetentionNumber | Integer | No | 60 |
The number of log backup files that you want to retain on the instance. Default value: 60. Valid values: 6 to 100. Note
|
Category | String | No | Standard |
Specifies whether to enable the single-digit second backup feature. This feature allows ApsaraDB RDS to complete a backup within a few seconds. Valid values:
Note This parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy.
|
BackupInterval | String | No | 30 |
The frequency at which you want to perform a snapshot backup. Valid values:
Note
|
BackupMethod | String | No | Physical |
The backup method of the instance. Valid values:
Default value: Physical. Note
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CompressType | String | 4 |
The format into which backup files are compressed. Valid values:
|
DBInstanceID | String | rm-uf6wjk5xxxxxxx |
The ID of the instance. |
EnableBackupLog | String | 1 |
Indicates whether the log backup feature is enabled. Valid values:
|
HighSpaceUsageProtection | String | Disable |
Indicates whether ApsaraDB RDS forcibly deletes log backup files from the instance when the storage usage of the instance exceeds 80% or the amount of remaining storage on the instance is less than 5 GB. |
LocalLogRetentionHours | Integer | 18 |
The number of hours for which log backup files are retained on the instance. |
LocalLogRetentionSpace | String | 30 |
The maximum storage usage that is allowed for log backup files on the instance. |
LogBackupLocalRetentionNumber | Integer | 60 |
The number of log backup files that can be retained on the instance. |
RequestId | String | DA147739-AEAD-4417-9089-65E9B1D8240D |
The ID of the request. |
Examples
Sample requests
http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>
Sample success responses
XML
format
<ModifyBackupPolicyResponse>
<HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<EnableBackupLog>1</EnableBackupLog>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>
JSON
format
{
"HighSpaceUsageProtection": "Disable",
"DBInstanceID": "rm-bp1z3xxxxx",
"RequestId": "E4BF5598-ED12-4406-AAA4-F375428BE741",
"LocalLogRetentionHours": "18",
"EnableBackupLog": "1",
"LocalLogRetentionSpace": "30",
"LogBackupLocalRetentionNumber": 60
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidLogBackupFrequency.Malformed | Invalid log backup frequency. | The error message returned because the value of the LogBackupFrequency parameter is invalid. |
400 | InvalidBackupRetentionPeriod.Malformed | The specified backup retention period is invalid. | The error message returned because no backup retention period is specified. Specify a backup retention period. The backup retention period cannot be shorter than 1 day or longer than 30 days. |
400 | BackupPropertyNotFound | Backup policy not found | The error message returned because no backup policy can 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. | The error message returned because snapshot backup files cannot be stored to a region that is different from the region where the instance resides. Before you enable the snapshot backup feature, you must disable the cross-region backup feature. |
403 | OperationDenied.SwitchSnapshotToPhysical | Only physical backup to snapshot backup is supported. | The error message returned because the operation supports only the change from the physical backup method to the snapshot backup method. |
403 | OperationDenied.ModifyBackupSwitchOff | The switch is not turned on. It is forbidden to modify the backup mode. | The error message returned because the cross-region backup feature 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. | The error message returned because the log backup frequency cannot be the same as the data backup frequency when the snapshot backup feature is enabled. |
403 | OperationDenied.NotSupportedBackupMethod | When the storage is larger than 4000 GB, only snapshot backup is supported. | The error message returned because the instance supports only snapshot backups when the remaining storage is greater than 4,000 GB. |
403 | OperationDenied.ApiForbidden | Operation is not permitted. | The error message returned because the operation is not allowed. |
For a list of error codes, visit the API Error Center.