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

Querying Nodes of a DDM Instance

Function

This API is used to query nodes of a DDM instance.

Constraints

None

URI

GET /v1/{project_id}/instances/{instance_id}/nodes
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

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

nodes

Array of NodeList objects

Instance node information

total

Integer

Number of DDM instance nodes
Table 4 NodeList

Parameter

Type

Description

port

String

Port number of the instance node

status

String

Instance node status

node_id

String

Instance node ID

ip

String

IP address of the instance node

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 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

Example Response

Status code: 200

ok

{
    "nodes": [
        {
            "port": "5066",
            "status": "normal",
            "node_id": "47667f9ed2a54af7ba9ca46d8d37c26fno09",
            "ip": "192.168.0.179"
        }
    ],
    "total": 1
}

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