Queries the data backup files of an ApsaraDB RDS 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 Resourcesis 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:DescribeBackups | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
| BackupId | string | No | The ID of the backup set. | 327329803 |
| BackupStatus | string | No | The status of the backup set. Valid values:
| Success |
| BackupMode | string | No | The backup mode. Valid values:
| Automated |
| StartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2011-06-01T16:00Z |
| EndTime | string | No | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note
We recommend that you specify a time range that is as short as possible to avoid timeout.
| 2011-06-15T16:00Z |
| PageSize | integer | No | The number of entries to return on each page. Valid values:
Default value: 30. | 30 |
| PageNumber | integer | No | The number of the page to return. Valid values: any non-zero positive integer. Default value: 1. | 1 |
| BackupType | string | No | The backup type. Valid values:
| FullBackup |
| ResourceGroupId | string | No | The resource group ID. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
"TotalEcsSnapshotSize": 0,
"PageRecordCount": "30",
"TotalRecordCount": "100",
"PageNumber": "1",
"Items": {
"Backup": [
{
"StorageClass": "0",
"Encryption": "{}",
"BackupStatus": "Success",
"StoreStatus": "Disabled",
"ConsistentTime": 1576506856,
"BackupType": "FullBackup",
"CopyOnlyBackup": "0",
"BackupEndTime": "2019-02-13T12:20:00Z",
"MetaStatus": "OK",
"BackupInitiator": "System",
"BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/xxxxx",
"BackupMethod": "Physical",
"BackupStartTime": "2019-02-03T12:20:00Z",
"BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/xxxxx",
"IsAvail": 1,
"BackupId": "321020562",
"HostInstanceID": "5882781",
"BackupSize": 2167808,
"BackupMode": "Automated",
"DBInstanceId": "rm-uf6wjk5xxxxxxx",
"Checksum": "1835830439**********",
"BackupDownloadLinkByDB": {
"BackupDownloadLinkByDB": [
{
"IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1",
"DataBase": "dbs",
"DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=*****&dbList=tb1"
}
]
},
"ResourceGroupId": "rg-acfmy*****"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRestoreTime.Malformed | The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup. | - |
| 400 | InvalidPageNumbers.Malformed | Specified page number is not valid. | The page number cannot be found. |
| 400 | InvalidStartTime.Format | Specified start time is not valid. | The start time is invalid. |
| 400 | InvalidEndTime.Format | Specified end time is not valid. | The end time is invalid. Check the end time. |
| 400 | InvalidParameterCombination | The end time must be greater than the start time | The end time must be later than the start time. |
| 400 | InvalidDBinstanceClass.ValueNotSupported | The specified parameter DBinstanceClass is invalid. | The specified parameter DBinstanceClass is invalid. |
| 400 | InvalidBackupSetLocation.Format | Specified backup set location is not valid. | - |
| 403 | InvalidMaxRecordsPerPage.Malformed | Specified record number is not valid. | - |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
| 404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | The RDS instance cannot be found. Check the ID or name of the RDS instance. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||
|---|---|---|---|---|
| 2021-10-21 | The response structure of the API has changed | see changesets | ||
|