Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Backup Management/ Restoring Data to a New Instance (a V3 API)
Updated on 2026-05-30 GMT+08:00
View PDF
Share

Restoring Data to a New Instance (a V3 API)

Function

This API is used to restore data to a new instance.

URI

POST /v3/{project_id}/instances/{instance_id}/backups/recovery

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

DDM instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

source

Yes

RestoreInstSource object

Source instance for data restoration.

target

Yes

RestoreInstTarget object

Target instance for data restoration.

data_node_relations

Yes

Array of DataNodeRelation objects

Associated data nodes.
Table 4 RestoreInstSource

Parameter

Mandatory

Type

Description

restore_time

Yes

Number

Point in time to which the tables are restored.
Table 5 RestoreInstTarget

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.
Table 6 DataNodeRelation

Parameter

Mandatory

Type

Description

source_instance_id

Yes

String

Source data node ID. It can be obtained from Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API).

target_instance_id

Yes

String

Target data nodes. They can be obtained from Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API).

Response Parameters

Status code: 202

Table 7 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

POST https://{endpoint}/v3/{project_id}/instances/{instance_id}/backups/recovery

{
  "source" : {
    "restore_time" : 1747732352076
  },
  "target" : {
    "instance_id" : "2f0324a93859487eb5566d75951fcd2din09"
  },
  "data_node_relations" : [ {
    "source_instance_id" : "f4e2949e9b9b4d60b42c89ed39bfe34cin01",
    "target_instance_id" : "f4e2949e9b9b4d60b42c89ed39bfe34cin01"
  } ]
}

Example Response

Status code: 202

{
  "job_id": "09902ee7866649b8908ec209bfee2747"
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes

Description

202

OK

400

Bad request

500

Server error

Error Codes

For details, see Error Codes.

Parent topic: Backup Management