Updated on 2026-06-22 GMT+08:00

Querying the Node List

Function

This API is used to query the node list.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

node_ids

No

Array of strings

Definition

Node ID list.

Constraints

N/A

Range

N/A

Default Value

null

offset

No

Integer

Definition

Page offset, which starts from 0 (page number minus 1).

Constraints

N/A

Range

Greater than or equal to 0

Default Value

0

limit

No

Integer

Definition

Number of items displayed on each page.

Constraints

N/A

Range

N/A

Default Value

100

filter_by

No

String

Definition

Search criteria.

Constraints

N/A

Range

instCreateType: The content is filtered by resource status.

status: The content is filtered by node status.

Default Value

null

filter

No

String

Definition

Content to be searched.

Constraints

N/A

Range

When the resource status is used as the search criteria, the values are as follows:

  • ALL

  • INST

  • NODE

  • ALL

  • CREATING

  • FREE

  • ACTIVE

  • FAILED

  • UNKNOWN

  • CREATE_FAILED

  • DELETING

  • DELETE_FAILED

When the node status is used as the search criteria, the values are as follows:

Default Value

null

order_by

No

String

Definition

Sorting field. By default, the results are not sorted.

Constraints

N/A

Range

name: filter by name

Default Value

null

order

No

String

Definition

Sorting order (ascending or descending)

Constraints

N/A

Range

asc

desc

Default Value

null

deleted

No

String

Definition

Whether the node is deleted. This field has been deprecated.

Constraints

N/A

Range

N/A

Default Value

null

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

node_list

Array of ClusterNodeInfo objects

Definition

Cluster node list.

Range

N/A

count

Integer

Definition

Total number of nodes in a cluster.

Range

An integer greater than 0

failed_count

Integer

Definition

Total number of failed nodes in a logical cluster. Generally, the value is 0.

Range

An integer greater than or equal to 0

Table 4 ClusterNodeInfo

Parameter

Type

Description

id

String

Definition

Node ID.

Range

N/A

name

String

Definition

Node name.

Range

N/A

status

String

Definition

Node status.

Range

N/A

sub_status

String

Definition

Node sub-status.

Range

N/A

spec

String

Definition

Node flavor.

Range

N/A

inst_create_type

String

Definition

Instance creation type.

Range

  • INST: node in use

  • NODE: idle node

alias_name

String

Definition

Node alias.

Range

N/A

az_code

String

Definition

AZ code.

Range

N/A

Example Requests

  • Query the node list.

    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

Example Responses

Status code: 200

Cluster node information queried.

{
  "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
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListClusterNodesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClusterNodesRequest request = new ListClusterNodesRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListClusterNodesResponse response = client.listClusterNodes(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListClusterNodesRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_cluster_nodes(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListClusterNodesRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListClusterNodes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Cluster node information queried.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.