Restores individual databases or tables of an instance to the original instance.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
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. | rm-uf6wjk5xxxxxxxxxx |
| BackupId | string | No | The backup set ID. You can call the DescribeBackups operation to obtain the backup set ID. Note
You must specify at least one of BackupId or RestoreTime parameters.
| 9026262 |
| RestoreTime | string | No | The point in time to which you want to restore data. The point in time must fall within the specified log backup retention period. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
| 2011-06-11T16:00:00Z |
| TableMeta | string | Yes | The names of the databases and tables that you want to restore. The value is in the following format: | [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}] |
| InstantRecovery | boolean | No | Specifies whether to enable the fast restoration feature for individual databases and tables. Valid values:
Note
For more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL instance.
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EA2D4F34-01A7-46EB-A339-D80882135206"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidRestoreType.Format | Specified restore type is not valid. | The restoration type is invalid. Specify a valid restoration type. |
| 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 | InvalidBakset.Invalid | Specified bakset is not valid. | - |
| 400 | InvalidParamTableMeta | Invalid parameter TableMeta is null or not json format | The value of the TableMeta parameter is invalid. Check the value of this parameter. |
| 400 | InvalidBakHistoryDO | BakHistory is inbalid when check restore TableMeta | - |
| 400 | InvalidBakTableMetaDO | BakTableMeta in BakHistory.Info is invalid | - |
| 400 | InvalidParamTableMeta.Content | TableMeta has duplicate db.table in newname or with common. | - |
| 400 | InvalidParamTableMeta.Duplicate | TableMeta has duplicate db or table with other newname, commons or system | The operation failed. The databases and tables that you want to restore already exist in the RDS instance. |
| 400 | InvalidSourceRestoreDBName.NotFound | specific source restore dbname is not found in db list | The operation failed. The data backup file does not contain the data of the databases. |
| 400 | InvalidParamTableMetaForRestore.Content | new dbname or table in TableMeta cannot be same with old when restore to source instance | - |
| 400 | InvalidDBName.Duplicate | Specified DB name already exists in the This instance. | A database with the same name has been created on the RDS instance. Specify a different name. |
| 400 | InvalidParameters.Format | Specified parameters is not valid. | The values of some parameters are invalid. |
| 400 | InvalidAvZone.Format | Specified AvZone is not valid. | The value of the AvZone parameter is invalid. Check the value of this parameter. |
| 400 | InvalidRegion.Format | Specified Region is not valid. | The region ID is invalid. Check the region ID. |
| 400 | InvalidIP.Format | Specified ip is not valid. | - |
| 400 | InvalidVpcParameter | Specified VPCId VSwitchId or IPAddress or TunnelId is not valid. | The values of the VPCId parameter and the VSwitchId parameter are invalid. Check the values of these parameters. |
| 400 | MissingUserID | The request is missing a user_id parameter. | The user ID cannot be found. |
| 400 | MissingUID | The request is missing a uid parameter. | The operation failed. The UID in the request is left unspecified. |
| 400 | MissBackupSetAndRestoreTime.NotFound | Both BackupSet and RestoreTime are null. | The operation failed. The BackupSet parameter and the RestoreTime parameter are left unspecified. |
| 400 | InvalidBakHistory.DbVersionMismatch | db version of bakhistory is mismatch with custins | For database and table restoration, the new instance must run the same engine version as the original instance. |
| 400 | DiskSize.NotEnough | The disk size is not enough to restore tables. | - |
| 400 | InvalidSourceCategory | specified source category is not supported for this function. | - |
| 400 | RestoreTableException | RestoreTable Exception, result is null. | - |
| 400 | InvalidParamTableMeta.TooManyTables | At most 100 tables are supported. Restoring the database is recommended. | - |
| 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 user center 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. | Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024. |
| 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. | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. |
| 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 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
| 400 | KmsApiError | User secret key invalid. | The user key is invalid. |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | - |
| 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 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | IncorrectBackupSetMethod | Current backup set method does not support operations. | The operation failed. The data backup file does not support the restoration of individual databases and tables. |
| 403 | IncorrectBackupSetState | Current backup set state does not support operations. | The operation failed. The data backup file is not in a ready state. |
| 403 | ChildDBInstanceExists | Current DB instance had child instance. | The read-only instance already exists. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | - |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | - |
| 404 | InvalidBackup.NotFound | The available backup does not exist in recovery time. | No available data backup file can be used to restore data. |
| 404 | InvalidBinlog.NotFound | The available binlog does not exist in recovery time. | The binary log file at the specified point in time is invalid. |
| 404 | InvalidBackupSetID.NotFound | Specified backup set ID does not exist. | The backup set does not exist. Specify an available backup set. |
| 404 | InvalidDB.NotFound | Specified db does not exist or DB status does not support. | - |
| 404 | InvalidRegion.NotFound | Specified Region does not exist in RDS. | Specified Region does not exist in RDS. |
| 404 | InsufficientResourceCapacity | There is insufficient capacity available for the requested instance. | - |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | The RDS instance cannot be found, is deleted, or does not support the operation. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 500 | ResourceConfigError | The request processing has failed due to resource config error. | - |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-06-26 | The Error code has changed | View Change Details |
| 2023-06-20 | The Error code has changed | View Change Details |
| 2023-04-18 | The Error code has changed | View Change Details |
| 2023-03-31 | The Error code has changed | View Change Details |
| 2022-01-10 | The Error code has changed | View Change Details |