Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ DDM Instance Management/ Querying Details of a DDM Instance Node
Updated on 2022-08-17 GMT+08:00
View PDF
Share

Querying Details of a DDM Instance Node

Function

This API is used to query details of the specified 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

instance_id

Yes

String

DDM instance ID

node_id

Yes

String

Node ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

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

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

Example Response

Status code: 200

ok

{
    "status": "normal",
    "name": "ddm-test_node_01",
    "node_id": "47667f9ed2a54af7ba9ca46d8d37c26fno09",
    "private_ip": "192.168.0.179",
    "floating_ip": "100.64.144.132",
    "server_id": "47b059b2-df84-48b8-a281-ce7bf766a1eb",
    "subnet_name": null,
    "datavolume_id": "073050cb-c8df-4f2b-b7d3-a168d36fd5d2",
    "res_subnet_ip": "172.16.13.156",
    "systemvolume_id": "7a7211f3-aad1-4641-b387-57a8c3567268"
}

Status code: 400

bad request

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

Status code: 500

server error

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

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management