Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Querying Nodes of a DDM Instance
Updated on 2022-09-15 GMT+08:00
View PDF

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
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Which page the server starts returning items. The start value cannot be less than 0. The default value is 0.

Minimum value: 0

limit

No

Integer

Number of records displayed on each page. The value is greater than 0 and not greater than 128. The default value is 128.

Minimum value: 1

Maximum value: 128

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling an IAM API. 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

nodes

Array of NodeList objects

Instance node information

offset

Integer

Which page the server starts returning items.

limit

Integer

Number of records displayed on each page

total

Integer

Number of DDM instance nodes
Table 5 NodeList

Parameter

Type

Description

port

String

Port

status

String

Node status

node_id

String

Node ID

ip

String

ip

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 7 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" : "4a2b97b7f5e3462c9c78aae93b46ed83no09,",
    "ip" : "192.168.0.160"
  } ],
  "offset" : "DBS.280001",
  "limit" : 128,
  "total" : 1
}

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