Restoring Data to an Existing DB Instance
Function
This API is used to restore a database to an existing DB instance.
- Before calling an API, you need to understand the API in Authentication.
Constraints
- This API does not support RDS for PostgreSQL instance restoration.
- When data is restored to an existing DB instance, the API has the following constraints:
- The DB engine of the original DB instance must be the same as that of the target DB instance. For example, if the original DB instance is running MySQL, the target DB instance must also run MySQL.
- The DB engine version of the target instance must be at least equal to that of the original instance. For example, an RDS for MySQL 5.7.25 instance can be restored to an RDS for MySQL 5.7.27 instance.
- The total storage space of the target DB instance must be at least equal to that of the original DB instance.
- Cross-region restoration is not supported.
- For RDS for MySQL DB instances, when data is restored to an existing DB instance, the case sensitivity setting of the existing DB instance must be the same as that of the original DB instance. Otherwise, the restoration may fail.
URI
- URI format
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the project ID of a tenant in a region.
For details about how to obtain the project ID, see Obtaining a Project ID.
Request
Name |
Mandatory |
Type |
Description |
---|---|---|---|
source |
Yes |
Object |
Specifies the restoration information. For details, see Table 3. |
target |
Yes |
Object |
Specifies the restoration target. For details, see Table 4. |
Name |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Specifies the DB instance ID. |
type |
No |
String |
Specifies the restoration mode. Enumerated values include:
|
backup_id |
No |
String |
Specifies the ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration. |
restore_time |
No |
Integer |
Specifies the time point of data restoration in the UNIX timestamp. The unit is millisecond and the time zone is UTC. |
Example Request
- Restoring data to a DB instance from a backup
{ "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "backup", "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe" }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } }
- Restoring instance data to a specific point in time
{ "source": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01", "type": "timestamp", "restore_time": 1532001446987 }, "target": { "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01" } }
Response
- Normal response
Table 5 Parameter description Name
Type
Description
job_id
String
Indicates the job ID.
- Example normal response
{ "job_id": "ff80808157127d9301571bf8160c001d" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.