更新时间:2025-08-29 GMT+08:00
分享

查询节点信息

功能介绍

查询节点信息

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

HTAP标准版实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in17,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

node_list

Array of node_list objects

参数解释

HTAP标准版实例节点列表。

约束限制

不涉及。

表4 node_list

参数

参数类型

描述

node_id

String

参数解释

HTAP标准版实例节点ID。

取值范围

不涉及。

node_name

String

参数解释

HTAP标准版实例节点名称。

取值范围

不涉及。

role

String

参数解释

HTAP标准版实例节点角色。

取值范围

  • fe-leader

  • fe-follower

  • fe-observer

  • be

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及。

error_msg

String

参数解释

错误描述

取值范围

不涉及。

状态码:500

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及。

error_msg

String

参数解释

错误描述

取值范围

不涉及。

请求示例

查询节点信息

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

响应示例

状态码:200

Success

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

状态码:400

Error response

{
  "error_code" : "DBS.200022",
  "error_msg" : "实例不存在"
}

状态码

状态码

描述

200

Success

400

Error response

500

Server error.

错误码

请参见错误码

相关文档