Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Standard Edition)/ Querying Node Information
Updated on 2025-09-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Node Information

Function

This API is used to query node information. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Standard HTAP instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in17. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

node_list

Array of node_list objects

Definition

Nodes of a standard HTAP instance.

Constraints

N/A
Table 4 node_list

Parameter

Type

Description

node_id

String

Definition

ID of a standard HTAP instance node.

Range

N/A

node_name

String

Definition

Name of a standard HTAP instance node.

Range

N/A

role

String

Definition

Role of a standard HTAP instance node.

Range

  • fe-leader

  • fe-follower

  • fe-observer

  • be

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Request

Querying node information

GET https://{endpoint}/rds/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/28f61af50fc9452aa0ed5ea25c3cin17/starrocks/nodes

Example Response

Status code: 200

Success

{
  "node_list" : [ {
    "node_id" : "f1a5641d62f44803ac38ffefed0e4736no07",
    "node_name" : "htap-node01",
    "role" : "fe-leader"
  } ]
}

Status code: 400

Error response

{
  "error_code" : "DBS.200022",
  "error_msg" : "Instance not found."
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: HTAP (Standard Edition)