RestoreTable - ApsaraDB RDS - Alibaba Cloud Documentation Center

Restores individual databases or tables of an instance to the original instance.

Operation Description

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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

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:RestoreTable	WRITE	RDS acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	ETnLKlblzczshOTUbOCzxxxxxxxxxx	ETnLKlblzczshOTUbOCzxxxxxxxxxx
DBInstanceId	string	Yes	Specifies whether to enable the fast restoration feature for individual databases and tables. Valid values: true: enables the feature. false: disables the feature. NoteFor more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL instance.	rm-uf6wjk5xxxxxxxxxx
BackupId	string	No	Restores individual databases or tables of an instance to the original instance.	9026262
RestoreTime	string	No	ApsaraDB RDS for MySQL supports the restoration of individual databases and tables. If you delete databases or tables from an instance, you can restore the databases or tables by using a backup file. For more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL instance. Before you call this operation, make sure that the following requirements are met: The instance is in the Running state. The instance does not have ongoing migration tasks. If you want to restore data to a specific point in time, make sure that the log backup feature is enabled for the instance. For more information, see Back up an ApsaraDB RDS for MySQL instance. The restoration of individual databases or tables is enabled, and new backups are created. For more information, see Restore individual databases and tables of an ApsaraDB RDS for MySQL instance. The names that you want to use for the restored tables do not exist in the instance. NoteThis operation is supported only for instances that run MySQL.	2011-06-11T16:00:00Z
TableMeta	string	Yes	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 token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	[{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]
InstantRecovery	boolean	No	The ID of the instance.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the backup set. You can call the DescribeBackups operation to obtain the ID of the backup set. NoteYou must specify at least one of BackupId and RestoreTime.	EA2D4F34-01A7-46EB-A339-D80882135206

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 missing old dbname or new dbname, please check	The value of the table_meta parameter does not contain the names of the source and destination tables.
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.	-
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.
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.	-
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.
500	ResourceConfigError	The request processing has failed due to resource config error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-04-18

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500

2023-03-31

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500

2022-01-10

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Error Codes 400 change
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500