Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Querying Details of a DDM Instance Node
Updated on 2024-08-02 GMT+08:00
View PDF
Share

Querying Details of a DDM Instance Node

Function

This API is used to query details of a DDM instance node.

Constraints

None

URI

GET /v1/{project_id}/instances/{instance_id}/nodes/{node_id}

Table 1 Path 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

node_id

Yes

String

DDM instance node 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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Node status

name

String

Node name

node_id

String

Node ID

private_ip

String

Private IP address of the node

floating_ip

String

Floating IP address of the node

server_id

String

VM ID

subnet_name

String

Subnet name

datavolume_id

String

Data disk ID

res_subnet_ip

String

IP address provided by the resource subnet

systemvolume_id

String

System disk ID

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

Querying details of a DDM instance node

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/nodes/{node_id}

Example Response

Status code: 200

OK

{
  "status" : "normal",
  "name" : "ddm2-test_node_01",
  "node_id" : "4a2b97b7f5e3462c9c78aae93b46ed83no09",
  "private_ip" : "192.168.0.160",
  "floating_ip" : "100.65.78.158",
  "server_id" : "8bd4d0bd-f63e-489a-95b6-50351f9657e6",
  "datavolume_id" : "30ade9fb-26de-4d1f-af08-c376974b9d86",
  "res_subnet_ip" : "172.16.15.224",
  "systemvolume_id" : "88d7de55-f886-4929-ae7c-04d842959700"
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances