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 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:DescribeMetaList | get | *DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 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 restoration method that you want to use. 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 IDs of data backup files. Note
This parameter is required when you set the RestoreType parameter 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
JSONformat
{
"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. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | Pricing plan price result not found. |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support. |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | The module you purchased is not legal, please buy it again. |
| 400 | RegionEndTimeDissolvedIndia | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. | Hello customer, this area has been abolished. |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | - |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | - |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | - |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 403 | InvalidMeta.Empty | Meta information is empty. | The meta information is empty. Check whether a full backup has not been performed after the database table is restored. |
| 403 | InvalidMeta.TooLarge | Meta information is too large. | The metadata information is too large. Check whether the number of instance tables exceeds 50000. |
| 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. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 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 |
|---|---|---|
| 2024-11-20 | API Description Update. The Error code has changed | View Change Details |
| 2024-04-28 | The Error code has changed | View Change Details |
| 2022-08-04 | The Error code has changed. The request parameters of the API has changed | View Change Details |