Queries the information about the databases and tables that can be restored from a specified backup set.
Operation description
Supported database engines
MySQL
Description
Before you call the RestoreTable operation to restore individual databases or tables of an ApsaraDB RDS for MySQL instance, you can call this operation to query the information about the databases and tables that can be restored. For more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL 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 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:DescribeMetaList | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the generated token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-uf6wjk5xxxxxxx |
RestoreType | string | No | The method that is used to restore data. Valid values:
Default value: BackupSetID. | BackupSetID |
BackupSetID | integer | No | The ID of the backup set from which you want to restore data. You can call the DescribeBackups operation to query the backup set ID. Note
This parameter must be specified when the RestoreType parameter is set to BackupSetID.
| 14358 |
RestoreTime | string | No | The point in time to which you want to restore data. The specified point in time must be earlier than the current time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. You can call the DescribeBackups operation to query the restorable time range. Note
This parameter must be specified when the RestoreType parameter is set to RestoreTime.
| 2019-05-30T03:29:10Z |
GetDbName | string | No | The name of the database to query. The system implements exact match based on the value of this parameter and returns the name of the matched database and the names of all tables contained in the database. Note
If you leave this parameter empty, the system returns all databases that are created on the instance.
| testdb1 |
Pattern | string | No | The name of the database to query. The system implements fuzzy match based on the value of this parameter and returns only the name of the matched database. Note
For example, if you set the value to test , the system returns testdb1 and testdb2 . Then, you can specify the GetDbName parameter to query tables in the required database.
| test |
PageSize | integer | No | The number of entries to return on each page. Default value: 1. Note
This parameter only takes effect when you specify the PageIndex parameter.
| 1 |
PageIndex | integer | No | The number of the page to return. Valid values: any non-zero positive integer.**** Default value: 1. Note
This parameter only takes effect when you specify the PageSize parameter.
| 1 |
ResourceGroupId | string | No | The resource group ID. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBInstanceName": "rm-uf6wjk5xxxxxxx",
"TotalPageCount": 1,
"RequestId": "60F9A12A-16B8-4728-B099-4CA38D32C31C",
"PageRecordCount": 1,
"TotalRecordCount": 1,
"PageNumber": 1,
"Items": {
"Meta": [
{
"Tables": "test1",
"Database": "testdb1",
"Size": "64"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | NoAvailableDisasterRestoreBakset | No available disaster restore bakset | - |
400 | InvalidPageSize | The page size is invalid | The value of the pageSize parameter is invalid. The value of this parameter must be a number. |
400 | InvalidPageIndex | The page index is invalid | - |
400 | InvalidRestoreTime.Format | Specified restore time is not valid. | The operation failed. The point in time is invalid. Specify a valid point in time. |
403 | InvalidMeta.Empty | Meta information is empty. | You must specify the metadata. |
403 | InvalidMeta.TooLarge | Meta information is too large. | - |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
403 | IncorrectEngineVersion | Current engine version does not support operations. | The operation failed. The operation is not supported for the version of the database engine that is run on the RDS instance. |
403 | InvalidBackupLogStatus | Current backup log enable status does not support this operation. | The operation failed. Log backups are not enabled, and therefore data cannot be restored to a specified point in time. |
404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | The backup set does not exist. Specify an available backup set. |
404 | InvalidParameters.Format | Specified parameter({}) is not valid. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2022-08-04 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||
|