Restoring Data to an Existing or Original DB Instance¶

Function¶

This API is used to restore a database to an existing or the original DB instance.

Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.

URI¶

URI format
POST https://{Endpoint}/v3/{project_id}/instances/recovery
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.

**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¶

Parameter description

**Table 2** Parameter description¶
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.

**Table 3** source field data structure description¶
Name	Mandatory	Type	Description
instance_id	Yes	String	Specifies the DB instance ID.
type	No	String	Specifies the restoration mode. Enumerated values include: backup: indicates using backup files for restoration. In this mode, type is not mandatory and backup_id is mandatory. timestamp: indicates the point-in-time restoration mode. In this mode, type is mandatory and restore_time is no mandatory.
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.

**Table 4** target field data structure description¶
Name	Mandatory	Type	Description
instance_id	Yes	String	Specifies the ID of the DB instance to be restored to.

Example
POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/recovery

Request example

Use backup files for restoration:

{
    "source": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
        "type": "backup",
        "backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
    },
    "target": {
        "instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
    }
}

Use PITR for restoration:

{
    "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 task ID.

**Table 5** Parameter description¶
Name	Type	Description
job_id	String	Indicates the task ID.

Example normal response

{
    "job_id": "ff80808157127d9301571bf8160c001d"
}

Abnormal Response
For details, see Abnormal Request Results.

Status Code¶

Normal
200
Abnormal
For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-18 01:11