Queries the backup settings of an instance.
Operation Description
debugging
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 | Associated operation |
---|---|---|---|---|
rds:DescribeBackupPolicy | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the ID of the instance. | rm-uf6wjk5xxxxxxx |
BackupPolicyMode | string | No | The backup type. Valid values:
| DataBackupPolicy |
CompressType | string | No | The method that is used to compress backup data. Valid values:
| 1 |
ReleasedKeepPolicy | string | No | The policy that is used to retain archived backup files if the instance is released. Valid values:
| Lastest |
Response parameters
Examples
Sample success responses
JSON
format
{
"LogBackupRetentionPeriod": 7,
"ArchiveBackupKeepPolicy": "ByMonth",
"ArchiveBackupKeepCount": "1",
"LocalLogRetentionHours": 0,
"BackupRetentionPeriod": 7,
"RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
"PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
"CompressType": "1",
"SupportReleasedKeep": 0,
"LocalLogRetentionSpace": "30",
"SupportVolumeShadowCopy": 1,
"BackupMethod": "Physical",
"LogBackupFrequency": "LogInterval",
"PreferredNextBackupTime": "2018-01-19T15:15Z",
"HighSpaceUsageProtection": "Enable",
"ArchiveBackupRetentionPeriod": "365",
"BackupInterval": "30",
"ReleasedKeepPolicy": "None",
"PreferredBackupTime": "15:00Z-16:00Z",
"LogBackupLocalRetentionNumber": 60,
"Category": "Standard",
"EnableBackupLog": "1",
"BackupLog": "Enable",
"EnableIncrementDataBackup": true,
"SupportModifyBackupPriority": true,
"BackupPriority": 2
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IO.Exception | IO exception, retry later. | An I/O error occurred. |
400 | InternalFailure | Internal failure, retry later. | The request failed. Please try again later. |
400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | The operation failed. The value of the OwnerAccount parameter is invalid. Check the value of this parameter. |
400 | InvalidEngine.Malformed | Specified engine is not valid. | The database engine is invalid. Specify a valid database engine. |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | The RDS instance cannot be found, is deleted, or does not support the operation. |
404 | InvalidDBInstanceName.NotFound | Invalid DBInstanceId NotFound. | The instance ID cannot be found. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-06-29 | The error codes of the API operation change.,The response structure of the API operation changes. | see changesets | ||||||||||
| ||||||||||||
2022-06-24 | API Description Update,The error codes of the API operation change. | see changesets | ||||||||||
|