You can call the ModifyBackupPolicy operation to modify the backup settings of an instance.
Operation Description
Before you call this operation, make sure that the following requirements are met:
- The instance is not a read-only instance.
- The instance is in the Running state.
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Association operation |
---|---|---|---|---|
rds:ModifyBackupPolicy | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The ID of the instance. You can call the DescribeDBInstances operation to query the IDs of instances. | rm-uf6wjk5xxxxxxx |
BackupPolicyMode | string | No | The type of the backup that you want to perform. Valid values:
| DataBackupPolicy |
PreferredBackupTime | string | No | 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 | 00:00Z-01:00Z |
PreferredBackupPeriod | string | No | The backup cycle. Specify at least two days of the week and separate the days with commas (,). Valid values:
Note | Monday |
BackupRetentionPeriod | string | No | The number of days for which you want to retain data backup files. Valid values: 7 to 730. Note | 7 |
BackupLog | string | No | Specifies whether to enable the log backup feature. Valid values:
Note | Enable |
LogBackupRetentionPeriod | string | No | 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 | 7 |
EnableBackupLog | string | No | Specifies whether to enable the log backup feature. Valid values:
Note | 1 |
LocalLogRetentionHours | string | No | The number of hours for which you want to retain log backup files on the instance. Valid values: 0 to 168. The value 0 specifies that log backup files are not retained on the instance. The value 168 is calculated based on the following formula: 7 × 24. Note | 18 |
LocalLogRetentionSpace | string | No | 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. You can retain the default value. Note | 30 |
HighSpaceUsageProtection | string | No | 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. You can retain the default value. Note | Enable |
LogBackupFrequency | string | No | The frequency at which you want to back up logs of the instance. Valid values:
Note | LogInterval |
CompressType | string | No | The format into which backups are compressed. Valid values:
NoteThis parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy. | 4 |
ArchiveBackupRetentionPeriod | string | No | 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. NoteThis parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy. | 365 |
ArchiveBackupKeepPolicy | string | No | The time frame within 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:
NoteThis parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy. | ByMonth |
ArchiveBackupKeepCount | integer | No | The number of archived backup files that you want to retain. Default value: 1. Valid values:
Note | 1 |
ReleasedKeepPolicy | string | No | The policy based on which ApsaraDB RDS retains archived backup files if the instance is released. Default value: None. Valid values:
NoteThis parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy. | None |
LogBackupLocalRetentionNumber | integer | No | The number of binary log files that you want to retain on the instance. Default value: 60. Valid values: 6 to 100. Note | 60 |
Category | string | No | 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:
NoteThis parameter takes effect only when you set the BackupPolicyMode parameter to DataBackupPolicy. | Standard |
BackupInterval | string | No | The frequency at which you want to perform a snapshot backup on the instance. Valid values:
Note | 30 |
BackupMethod | string | No | The backup method of the instance. Valid values:
Default value: Physical. Note | Physical |
EnableIncrementDataBackup | boolean | No | Specifies whether to enable the incremental backup feature. Valid values:
Note | false |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D",
"CompressType": "4",
"LocalLogRetentionSpace": "30",
"LogBackupLocalRetentionNumber": 60,
"DBInstanceID": "rm-uf6wjk5xxxxxxx",
"EnableBackupLog": "1",
"LocalLogRetentionHours": 18,
"HighSpaceUsageProtection": "Disable"
}
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. | - |
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2022-05-10 | The error codes of the API operation change. | |||||||
|