Queries the details of the databases or tables that can be restored.
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 |
---|---|---|---|---|
polardb:DescribeMetaList | Read |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBClusterId | string | Yes | The ID of the cluster. Note
You can call the DescribeDBClusters operation to query the details of all clusters under your account.
| pc-************** |
BackupId | string | No | The ID of the data backup file. Note
BackId or RestoreTime parameter. | 111111 |
RestoreTime | string | No | The point in time for the restoration. Specify the time in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. Note
When you run a query, you must specify the BackId or RestoreTime parameter. You can call the DescribeBackups operation to query the point in time for the restoration.
| 2020-10-04T01:40:00Z |
GetDbName | string | No | Specify the specific database name (such as Note
| test_db |
PageSize | integer | No | The number of entries to return on each page. Valid values:
| 30 |
PageNumber | integer | No | The number of the page to return. The value must be an integer that is greater than 0. Default value: 1. | 1 |
RegionCode | string | No | The ID of the region in which the instance resides. You can call the DescribeDBClusterAttribute operation to query the region ID of the instance. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSON
format
{
"TotalPageCount": "1",
"TotalRecordCount": "2",
"PageSize": "30",
"RequestId": "AA815DE7-B576-4B22-B33C-3FB31A******",
"PageNumber": "1",
"Items": [
{
"Database": "test_db",
"Tables": [
"test_tb1"
]
}
],
"DBClusterId": "pc-bp1s826a1up******"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidRestoreType.Format | Specified restore type is not valid. | The specified restore type is invalid. |
400 | InvalidRestoreTime.Format | Specified restore time is not valid. | The specified restoration time is invalid. |
400 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | The specified backup set ID does not exist. |
400 | IncorrectBackupSetState | Current backup set state does not support operations. | This operation is not supported while the backup set is in the current state. |
400 | InvalidDBName.Duplicate | Specified DB name already exists in the This instance. | The specified DBName parameter already exists in the cluster. |
400 | InvalidParameters.Format | Specified parameters is not valid. | The specified parameters are invalid. |
400 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | Insufficient storage capacity for the specified cluster. |
400 | InvalidRestoreType.NotFound | At least one of BackupId and RestoreTime is malformed. | The format of the specified BackupId or RestoreTime parameter is invalid. |
400 | MissingUserID | The request is missing a user_id parameter. | You must specify the UserID parameter in the request. |
400 | MissingUID | The request is missing a uid parameter. | You must specify the UID parameter in the request. |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
404 | InvalidBackup.NotFound | The available backup does not exist in recovery time. | The specified backup does not exist within the time range for restoration. |
404 | InvalidDBClusterId.NotFound | The DBInstanceId provided does not exist in our records. | The specified DBClusterId parameter does not exist in the current record. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-09-18 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-09-12 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2022-12-15 | The Error code has changed | see changesets | ||||||||||
| ||||||||||||
2021-10-18 | The Error code has changed | see changesets | ||||||||||
|