All Products
Search
Document Center

ApsaraDB RDS:RestoreTable

Last Updated:Jan 16, 2024

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

Operation description

Supported database engines

MySQL

References

Note Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Restore individual databases and tables

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.
OperationAccess levelResource typeCondition keyAssociated operation
rds:RestoreTableWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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
DBInstanceIdstringYes

The instance ID.

rm-uf6wjk5xxxxxxxxxx
BackupIdstringNo

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
RestoreTimestringNo

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
  • You must specify at least one of BackupId and RestoreTime.
  • You must enable the log backup feature. For more information, see Back up an ApsaraDB RDS for MySQL instance.
  • 2011-06-11T16:00:00Z
    TableMetastringYes

    The names of the databases and tables that you want to restore. The value is in the following format: [{"type":"db","name":"<The name of Database 1 on the source instance>","newname":"<The name of Database 1 on the destination instance>","tables":[{"type":"table","name":"<The name of Table 1 in Database 1 on the source instance>","newname":"<The name of Table 1 in Database 1 on the destination instance>"},{"type":"table","name":"<The name of Table 2 in Database 1 on the source instance>","newname":"<The name of Table 2 in Database 1 on the destination instance>"}]},{"type":"db","name":"<The name of Database 2 on the source instance>","newname":"<The name of Database 2 on the destination instance>","tables":[{"type":"table","name":"<The name of Table 3 in Database 2 on the source instance>","newname":"<The name of Table 3 in Database 2 on the destination instance>"},{"type":"table","name":"<The name of Table 4 in Database 2 on the source instance>","newname":"<The name of Table 4 in Database 2 on the destination instance>"}]}]

    [{"type":"db","name":"testdb1","newname":"testdb1_new","tables":[{"type":"table","name":"testdb1table1","newname":"testdb1table1_new"}]}]
    InstantRecoverybooleanNo

    Specifies whether to enable the fast restoration feature for individual databases and tables. Valid values:

    • true: enables the feature.
    • false: disables the feature.
    true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    EA2D4F34-01A7-46EB-A339-D80882135206

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "EA2D4F34-01A7-46EB-A339-D80882135206"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidRestoreType.FormatSpecified restore type is not valid.The restoration type is invalid. Specify a valid restoration type.
    400InvalidRestoreTime.FormatSpecified restore time is not valid.The operation failed. The point in time is invalid. Specify a valid point in time.
    400InvalidBakset.InvalidSpecified bakset is not valid.-
    400InvalidParamTableMetaInvalid parameter TableMeta is null or not json formatThe value of the TableMeta parameter is invalid. Check the value of this parameter.
    400InvalidBakHistoryDOBakHistory is inbalid when check restore TableMeta-
    400InvalidBakTableMetaDOBakTableMeta in BakHistory.Info is invalid-
    400InvalidParamTableMeta.ContentTableMeta has duplicate db.table in newname or with common.-
    400InvalidParamTableMeta.DuplicateTableMeta has duplicate db or table with other newname, commons or systemThe operation failed. The databases and tables that you want to restore already exist in the RDS instance.
    400InvalidSourceRestoreDBName.NotFoundspecific source restore dbname is not found in db listThe operation failed. The data backup file does not contain the data of the databases.
    400InvalidParamTableMetaForRestore.Contentnew dbname or table in TableMeta cannot be same with old when restore to source instance-
    400InvalidDBName.DuplicateSpecified 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.
    400InvalidParameters.FormatSpecified parameters is not valid.The values of some parameters are invalid.
    400InvalidAvZone.FormatSpecified AvZone is not valid.The value of the AvZone parameter is invalid. Check the value of this parameter.
    400InvalidRegion.FormatSpecified Region is not valid.The region ID is invalid. Check the region ID.
    400InvalidIP.FormatSpecified ip is not valid.-
    400InvalidVpcParameterSpecified 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.
    400MissingUserIDThe request is missing a user_id parameter.The user ID cannot be found.
    400MissingUIDThe request is missing a uid parameter.The operation failed. The UID in the request is left unspecified.
    400MissBackupSetAndRestoreTime.NotFoundBoth BackupSet and RestoreTime are null.The operation failed. The BackupSet parameter and the RestoreTime parameter are left unspecified.
    400InvalidBakHistory.DbVersionMismatchdb version of bakhistory is mismatch with custinsFor database and table restoration, the new instance must run the same engine version as the original instance.
    400DiskSize.NotEnoughThe disk size is not enough to restore tables.-
    400InvalidSourceCategoryspecified source category is not supported for this function.-
    400RestoreTableExceptionRestoreTable Exception, result is null.-
    400InvalidParamTableMeta.TooManyTablesAt most 100 tables are supported. Restoring the database is recommended.-
    403InvalidBackupLogStatusCurrent 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.
    403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    403IncorrectBackupSetMethodCurrent backup set method does not support operations.The operation failed. The data backup file does not support the restoration of individual databases and tables.
    403IncorrectBackupSetStateCurrent backup set state does not support operations.The operation failed. The data backup file is not in a ready state.
    403ChildDBInstanceExistsCurrent DB instance had child instance.The read-only instance already exists.
    404InvalidBackup.NotFoundThe available backup does not exist in recovery time.No available data backup file can be used to restore data.
    404InvalidBinlog.NotFoundThe available binlog does not exist in recovery time.The binary log file at the specified point in time is invalid.
    404InvalidBackupSetID.NotFoundSpecified backup set ID does not exist.The backup set does not exist. Specify an available backup set.
    404InvalidDB.NotFoundSpecified db does not exist or DB status does not support.-
    404InvalidRegion.NotFoundSpecified Region does not exist in RDS.-
    404InsufficientResourceCapacityThere is insufficient capacity available for the requested instance.-
    404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.The RDS instance cannot be found, is deleted, or does not support the operation.
    500ResourceConfigErrorThe request processing has failed due to resource config error.-

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

    Change history

    Change timeSummary of changesOperation
    2023-06-26The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-06-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-04-18The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2023-03-31The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500
    2022-01-10The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 500