更新时间:2024-04-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

表2 Query参数

参数

是否必选

参数类型

描述

deleted

String

保留,不推荐使用。可用node_ids代替:

  • “deleted = true”:node_ids非空。
  • “deleted = false”:node_ids为空。

node_ids

Array

节点ID列表。

offset

Integer

分页查询,偏移量,支持范围:0~10000。

limit

Integer

分页查询,每页显示的条目数量,支持范围:1~1000。

filter_by

String

过滤字段:

  • status:节点状态。
  • instCreateType:资源状态。

filter

String

过滤字段内容:

  • status = ALL:查询所有节点,包含已删除历史节点。
  • status = CREATING:创建中 。
  • status = FREE:空闲节点。
  • status = INIT:初始化。
  • status = ACTIVE:可用。
  • status = FAILED:不可用。
  • status = UNKNOWN:未知。
  • status = CREATE_FAILED:创建失败 。
  • status = DELETING:删除中。
  • status = DELETE_FAILED:删除失败 。
  • status = REBOOTING:重启中。
  • status = STOPPED:已停止。
  • instCreateType = ALL:查询所有节点,包含已删除历史节点。
  • instCreateType = INST:已使用 。
  • instCreateType = NODE:空闲。

order_by

String

排序字段:

  • 节点ID:id。
  • 节点名称:name 。
  • 节点状态:status。

order

String

排序方式:

  • 升序:asc。
  • 降序:desc。

请求参数

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

node_list

Array of ClusterNodeInfo objects

逻辑集群节点列表。

count

Integer

逻辑集群节点总数。

failed_count

Integer

逻辑集群节点失败总数。

表4 ClusterNodeInfo

参数

参数类型

描述

id

String

节点ID。

name

String

节点名称。

status

String

节点状态:

  • CREATING:创建中。
  • FREE:空闲。
  • ACTIVE:可用。
  • FAILED:不可用。
  • UNKNOWN:未知。
  • SERVER_FAILED:内部错误。
  • CREATE_FAILED:创建失败。
  • DELETING:删除中。
  • DELETE_FAILED:删除失败。
  • DELETED:已删除。
  • REBOOTING:重启中。
  • RESTORING:恢复中。
  • MODIFYING:修改中。
  • MODIFYING_PORT:绑定端口中。
  • INIT:初始化中。
  • STOPPED:已停止。

sub_status

String

节点子状态:

  • READY:节点ECS准备完成。
  • PREPARED:节点软件安装完成。
  • INITED:集群已创建。
  • CREATED:节点创建完成。

spec

String

节点规格。

inst_create_type

String

实例创建类型。

alias_name

String

节点别名。

az_code

String

可用区编码。

请求示例

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

响应示例

状态码: 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
}

SDK代码示例

SDK代码示例如下。

 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
49
50
51
52
53
54
55
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.*;

import java.util.List;
import java.util.ArrayList;

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");

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

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClusterNodesRequest request = new ListClusterNodesRequest();
        request.withDeleted("<deleted>");
        request.withNodeIds();
        request.withOffset(<offset>);
        request.withLimit(<limit>);
        request.withFilterBy("<filter_by>");
        request.withFilter("<filter>");
        request.withOrderBy("<order_by>");
        request.withOrder("<order>");
        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
33
34
35
36
37
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListClusterNodesRequest()
        request.deleted = "<deleted>"
        request.node_ids = 
        request.offset = <offset>
        request.limit = <limit>
        request.filter_by = "<filter_by>"
        request.filter = "<filter>"
        request.order_by = "<order_by>"
        request.order = "<order>"
        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
39
40
41
42
43
44
45
46
47
48
49
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")

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

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

    request := &model.ListClusterNodesRequest{}
	deletedRequest:= "<deleted>"
	request.Deleted = &deletedRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	filterByRequest:= "<filter_by>"
	request.FilterBy = &filterByRequest
	filterRequest:= "<filter>"
	request.Filter = &filterRequest
	orderByRequest:= "<order_by>"
	request.OrderBy = &orderByRequest
	orderRequest:= "<order>"
	request.Order = &orderRequest
	response, err := client.ListClusterNodes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询集群节点信息成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。