Queries the backup files of a Tair (Redis OSS-compatible) instance.
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 |
|---|---|---|---|---|
| kvstore:DescribeBackups | get | *DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the instance whose backup files you want to query. | r-bp1zxszhcgatnx**** |
| BackupId | integer | No | The ID of the backup file. | 11611111 |
| BackupJobId | integer | No | The backup task ID, returned by CreateBackup. If CreateBackup returns multiple BackupJobIds, you need to use this interface to query each of them separately. | 10001 |
| PageSize | integer | No | The maximum number of entries per page. Valid values: 30, 50, 100, 200, and 300. | 30 |
| PageNumber | integer | No | The page number. The value must be an integer that is greater than 0. Default value: 1. | 1 |
| StartTime | string | Yes | 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. | 2019-03-11T10:00Z |
| EndTime | string | Yes | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. The end time must be later than the start time. | 2019-03-14T18:00Z |
| NeedAof | string | No | Specifies whether to enable append-only files (AOFs) persistence. Valid values:
Note
The default value is 0.
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 5,
"FullStorageSize": 1000,
"LogStorageSize": 5000,
"FreeSize": 100000,
"Backups": {
"Backup": [
{
"BackupStatus": "Success",
"BackupStartTime": "2019-03-14T05:28:50Z",
"BackupType": "FullBackup",
"BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
"NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
"BackupEndTime": "2019-03-14T05:31:13Z",
"BackupId": 0,
"BackupDBNames": "all",
"EngineVersion": "4.0",
"BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
"BackupSize": 1024,
"BackupMode": "Automated",
"BackupMethod": "Physical",
"BackupJobID": 24340,
"RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}"
}
]
},
"AccessDeniedDetail": {
"AuthAction": "_",
"AuthPrincipalDisplayName": "_",
"AuthPrincipalOwnerId": "_",
"AuthPrincipalType": "_",
"EncodedDiagnosticMessage": "_",
"NoPermissionType": "_",
"PolicyType": "_"
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | The Specified parameter StartTime is not valid. | - |
| 400 | InvalidEndTime.Malformed | The Specified parameter EndTime is not valid. | The end time is invalid. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Example: 2011-06-11T16:00Z. |
| 400 | InvalidEngineVersion.Malformed | The Specified EngieVersion is not valid. | - |
| 400 | InvalidStartTimeAndEndTime.Malformed | The end time must be greater than the start time. | The end time must be later than the start time. |
| 400 | InvalidPageSize.Malformed | The specified parameter PageSize is not valid. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-06 | The Error code has changed | View Change Details |
| 2024-05-23 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-05-06 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-03-26 | The Error code has changed | View Change Details |
| 2024-01-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-01-03 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-11-13 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-11-06 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-07-25 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-11-29 | The Error code has changed. The response structure of the API has changed | View Change Details |