doc-exports/docs/ddm/api-ref/en-us_topic_0000002298949876.html

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.

Constraints

None

URI

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

Table 1 Path parameters

Parameter	Type	Mandatory	Description
project_id	String	Yes	Project ID of a tenant in a region
instance_id	String	Yes	Instance ID

Request Parameters

Table 2 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain the token by calling the IAM API used to obtain a user token.

Table 3 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 number but cannot be a 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	Long	Restoration timestamp, in milliseconds.

Example Request

GET https://ddm.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/related-dn?restore_time=1747728424956

Response

• Normal response

  Table 4 Response body parameters

  Parameter	Type	Description
  related_data_nodes	Array of RelatedDn objects	Associated data nodes
  latest_restorable_time	String	Latest point in time (in UTC) data can be restored to, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Central European time zone, the offset is +0100.
  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 RelatedDn

  Parameter	Type	Description
  instance_id	String	Instance ID
  instance_name	String	Instance name
  instance_status	String	Instance status. It can be obtained from DDM Instance Statuses.
  engine_name	String	Instance engine
  data_volume_size	String	Instance disk size, in bytes
  version	String	Instance version

• Normal response example

  {
  	"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
  }
  

• Abnormal response

  For details, see Abnormal Request Results.

Status Codes

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Backup Management