Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API)

Function

This API is used to query data nodes associated with an instance at a restoration time point.

URI

GET /v3/{project_id}/instances/{instance_id}/backups/related-dn

**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
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.
restore_time	Yes	String	Point in time to which the tables are restored.

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
related_data_nodes	Array of RelatedDnVO objects	Associated data nodes
latest_restorable_time	String	Latest restoration point in time
offset	Integer	Which page the server starts returning items
limit	Integer	Number of records displayed on each page
total	Integer	Total number of records

**Table 5** RelatedDnVO
Parameter	Type	Description
instance_id	String	Data node ID
instance_name	String	Data node name
instance_status	String	Data node status
data_volume_size	Number	Disk size
version	String	Version
engine_name	String	Engine name

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

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/related-dn?restore_time=1747728424956

Example Response

Status code: 200

{
	"related_data_nodes": [{
		"instance_name": "UTS-dtc-mysql_80_4u8g_single_2",
		"instance_id": "41c239a1e9bd4cd2aabd678bab45a886in01",
		"instance_status": "abnormal",
		"data_volume_size": 40000000000,
		"version": "8.0.32",
		"engine_name": "mysql"
	}],
	"latest_restorable_time": "2025-05-27T02:38:15+0000",
	"offset": 0,
	"limit": 100,
	"total": 1
}

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

Previous topic: Querying Backup Details (a V3 API)

Next topic: Querying the Restoration Time Range (a V3 API)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot