Queries a list of backup sets for an AnalyticDB for MySQL cluster.
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 |
---|---|---|---|---|
adb:DescribeBackups | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note
You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
| am-bp18934i73vb5**** |
BackupId | string | No | The ID of the backup set. | 32732**** |
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. | 2022-06-01T16:00Z |
EndTime | string | Yes | The end 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. The end time must be later than the start time. | 2022-06-02T16:00Z |
PageSize | integer | No | The number of entries per page. Valid values:
| 30 |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
CrossUid | string | No | The Alibaba Cloud account to which the backup set belongs. Note
This parameter must be specified only when cross-account backup operations are performed.
| 195**** |
CrossRole | string | No | The Resource Access Management (RAM) role of the Alibaba Cloud account to which the backup set belongs. Note
This parameter must be specified only when cross-account backup operations are performed.
| role-for-xxx |
RegionId | string | No | The region ID. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalCount": "300",
"PageSize": "30",
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": "1",
"Items": {
"Backup": [
{
"DBClusterId": "am-bp18934i73vb5****",
"BackupType": "FullBackup",
"BackupStartTime": "2022-06-01T16:00Z",
"BackupSize": 2167808,
"BackupEndTime": "2022-06-02T16:00Z",
"BackupId": "32732****",
"BackupMethod": "Snapshot"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | CrossUser.CheckFailed | The input UID and role is not authorized. | cross-account authentication failed. check whether the entered uid and role are correct, and whether the role trusts the adb service account |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-05-30 | The Error code has changed | View Change Details |
2024-05-30 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-11-14 | API Description Update. The Error code has changed | View Change Details |
2023-11-02 | API Description Update. The Error code has changed. The response structure of the API has changed | View Change Details |