Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Querying Details About an Instance Node (a V3 API)
Updated on 2026-05-30 GMT+08:00

Querying Details About an Instance Node (a V3 API)

Function

This API is used to query details about an instance node.

Constraints

None

URI

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

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

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.

Example Request

Querying details about an instance node
GET https://{endpoint}/v3/{project_id}/instances/{instance_id}/nodes/{node_id}

Response Parameters

  • Normal response
    Table 3 Response body parameters

    Parameter

    Type

    Description

    status

    String

    Node status. For details, see DDM Node Status.

    name

    String

    Node name

    id

    String

    Node ID

    private_ip

    String

    Private IP address of the node

    group_id

    String

    Group ID

    az_code

    String

    AZ

    subnet_id

    String

    Subnet ID.

Example Response

  • Normal response example
    {
      "id": "8d5601f17b30****da1e69181173cdno09",
      "private_ip": "172.16.203.68",
      "status": "normal",
      "name": "ddm-ag****de2_node_01",
      "subnet_id": "d27cdc75***b6-b2ab-fec93af33538",
      "az_code": "cn-southwest-244a",
      "group_id": "148a54****41ba6ed231487e73ccgr09"
    }

Status Code

Error Codes

For details, see Error Codes.