Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Backup Management/ Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API)
Updated on 2026-06-05 GMT+08:00
View PDF
Share

Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API)

Function

This API is used to query data nodes available to restore data to a point in time.

URI

GET /v3/{project_id}/instances/{instance_id}/backups/restorable-data-node

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

target_instance_id

Yes

String

Target instance ID.

source_dn_instance_id

Yes

String

Source data node ID.

restore_time

Yes

String

Point in time to which the tables are restored.

offset

No

Integer

Index offset.

The query starts from the next piece of data indexed by this parameter. The value is 0 by default.

The value must be a non-negative number.

limit

No

Integer

Maximum records to be queried.

Value range: 1 to 128

If the parameter value is not specified, 10 records are queried by default.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

target_data_nodes

Array of TargetDn4Restore objects

Target available data nodes.

offset

Integer

Definition

Which page the server starts returning items

Range

The value is greater than or equal to 0.

limit

Integer

Definition

Number of records on each page

Range

The value is greater than 0 and less than or equal to 128.

total

Integer

Definition

Total number of records

Range

N/A
Table 5 TargetDn4Restore

Parameter

Type

Description

instance_name

String

Instance name

instance_id

String

Instance ID

engine_name

String

Engine name

status

String

Status.

available

Boolean

Available or not

unavailable_reason

String

Reason why the instance cannot be used.

vpc_name

String

VPC name.

private_ip

String

Private IP address.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

Example Request

Querying data nodes available for restoration 
GET https://{endpoint}/v3/74f57817ca8f42e19318eb0e0ad41d18/instances/733c7e8d73a54c27b8308ec784a8be8cin09/backups/restorable-data-node?source_dn_instance_id=41c239a1e9bd4cd2aabd678bab45a886in01&target_instance_id=2f0324a93859487eb5566d75951fcd2din09&restore_time=1747730765390

Example Response

Status code: 200

{
	"target_data_nodes": [{
		"instance_name": "rds-f0e2",
		"instance_id": "55c26c79139446868919c5b8b2cbb542in01",
		"engine_name": "mysql",
		"status": "normal",
		"available": true,
		"unavailable_reason": "",
		"vpc_name": "vpc-ddm-172",
		"private_ip": "172.16.248.115"
	}, {
		"instance_name": "mysql_80_4u8g_single_2",
		"instance_id": "c5ee103325294f37a8a42e88ba51947ain01",
		"engine_name": "mysql",
		"status": "normal",
		"available": true,
		"unavailable_reason": "",
		"vpc_name": "vpc-ddm-172",
		"private_ip": "172.16.192.156"
	}],
	"offset": 0,
	"limit": 2,
	"total": 192
}

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

200

OK

400

Bad request

500

Server error

Error Codes

For details, see Error Codes.

Parent topic: Backup Management