Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Backup Management/ Restoring Data to the Original Instance or an Existing Instance
Updated on 2025-07-11 GMT+08:00
View PDF

Restoring Data to the Original Instance or an Existing Instance

Function

This API is used to restore data to the original instance or an existing instance. Before calling this API:

Constraints

DB instances will not be displayed unless they have the same DB engine type, version, and table name case sensitivity as the original DB instance.

URI

POST /v3/{project_id}/instances/restore

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Range:

The value contains 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

target_instance_id

Yes

String

Definition:

Target instance ID.

Constraints:

N/A

Range:

N/A

Default value:

N/A

source_instance_id

Yes

String

Definition:

Source instance ID.

Constraints:

N/A

Range:

N/A

Default value:

N/A

type

Yes

String

Definition:

Restoration mode.

Constraints:

N/A

Range:

  • backup: Data is restored using backups. In this case, backup_id is mandatory.

  • timestamp: Data is restored through PITR. In this case, restore_time is mandatory.

Default value:

N/A

backup_id

No

String

Definition:

ID of the backup to be restored. This parameter must be specified when a backup is used for restoration.

Constraints:

N/A

Range:

N/A

Default value:

N/A

restore_time

No

Long

Definition:

Backup time point.

Constraints:

The value is a Unix timestamp in milliseconds and represents UTC time. When specifying the parameter, convert the local time from your relevant time zone to a UTC timestamp first.

Range:

To obtain this value, see Querying the Restoration Time Range.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Definition:

Workflow ID.

Range:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

  • Restoring data to the original instance using a backup file 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "7ffbf305376b4cbea0ae491257b6aaf9br07",
  "type" : "backup"
}
  • Restoring data to the original instance through PITR 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}
  • Restoring data to an existing instance using a backup file 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "backup_id" : "be4ddfd7e2b94640b5e2cb44efb30b22br07",
  "type" : "backup"
}
  • Restoring data to an existing instance through PITR 
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/restore
{
  "target_instance_id" : "7033e7c3cf93438797d44ad7ae0a7d95in07",
  "source_instance_id" : "690e08a7c3854c218df0e59de3b0c6cein07",
  "restore_time" : 1673852043000,
  "type" : "timestamp"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Backup Management