更新时间:2025-09-18 GMT+08:00

查询节点列表

功能介绍

查询节点列表。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/clusters/{cluster_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

cluster_id

String

参数解释

集群ID。获取方法请参见获取集群ID

约束限制

必须是有效的dws集群ID。

取值范围

36位UUID。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

node_ids

Array of strings

参数解释

节点ID列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

offset

Integer

参数解释

分页偏移量,从0开始,页数减1。

约束限制

不涉及。

取值范围

大于等于0。

默认取值

0

limit

Integer

参数解释

分页查询,每页显示的条目数量。

约束限制

不涉及。

取值范围

不涉及。

默认取值

100

filter_by

String

参数解释

过滤字段。

约束限制

不涉及。

取值范围

instCreateType:根据资源状态过滤

status:根据节点状态过滤

默认取值

null

filter

String

参数解释

过滤字段内容。

约束限制

不涉及。

取值范围

当根据资源状态过滤时,可选如下值:

  • ALL:全部

  • INST:已使用

  • NODE:空虚

  • ALL:全部

  • CREATING:创建中

  • FREE:空闲

  • ACTIVE:可用

  • FAILED:不可用

  • UNKNOWN:未知

  • CREATE_FAILED:创建失败

  • DELETING:删除中

  • DELETE_FAILED:删除失败

当根据节点状态过滤时,可选如下值:

默认取值

null

order_by

String

参数解释

排序字段。默认无序返回。

约束限制

不涉及。

取值范围

name:根据名称过滤

默认取值

null

order

String

参数解释

排序:升序/降序。

约束限制

不涉及。

取值范围

asc:升序

desc:降序

默认取值

null

deleted

String

参数解释

是否被删除,字段已废弃。

约束限制

不涉及。

取值范围

不涉及。

默认取值

null

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

node_list

Array of ClusterNodeInfo objects

参数解释

集群节点列表。

取值范围

不涉及。

count

Integer

参数解释

集群节点总数。

取值范围

大于0的整数。

failed_count

Integer

参数解释

逻辑集群节点失败总数。一般为0。

取值范围

大于等于0的整数。

表4 ClusterNodeInfo

参数

参数类型

描述

id

String

参数解释

节点ID。

取值范围

不涉及。

name

String

参数解释

节点名称。

取值范围

不涉及。

status

String

参数解释

节点状态。

取值范围

不涉及。

sub_status

String

参数解释

节点子状态。

取值范围

不涉及。

spec

String

参数解释

节点规格。

取值范围

不涉及。

inst_create_type

String

参数解释

实例创建类型。

取值范围

  • INST:已使用

  • NODE:空闲节点

alias_name

String

参数解释

节点别名。

取值范围

不涉及。

az_code

String

参数解释

可用区编码。

取值范围

不涉及。

请求示例

  • 查询节点列表。

    GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes
  • GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=false&node_ids&offset=0&limit=10&filter_by=instCreateType&filter=INST
  • GET https://{Endpoint}/v2/9b06d044ea4f49f1a58b2bed2b0084bd/clusters/9b7ff56b-47b3-4d00-a1fd-4c023d34404b/nodes?deleted=true&node_ids=0000b3c5-384a-4fa7-ab86-2c44dd97660a&offset=0&limit=10

响应示例

状态码:200

查询集群节点信息成功。

{
  "node_list" : [ {
    "id" : "16413746-258e-4a3c-bea9-8496fdbefde3",
    "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-2-1",
    "status" : "ACTIVE",
    "sub_status" : "CREATED",
    "spec" : "dws2.kc1.2xlarge",
    "inst_create_type" : null,
    "alias_name" : null,
    "az_code" : "cn-north-4c"
  }, {
    "id" : "46d8754b-3ed3-4b92-85b5-7479ef5b10ac",
    "name" : "ty-default--BGy6PUIN-K-dws-cn-cn-1-1",
    "status" : "ACTIVE",
    "sub_status" : "CREATED",
    "spec" : "dws2.kc1.2xlarge",
    "inst_create_type" : null,
    "alias_name" : null,
    "az_code" : "cn-north-4c"
  } ],
  "count" : 2,
  "failed_count" : 0
}

状态码

状态码

描述

200

查询集群节点信息成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。