# 查询节点列表 - ListClusterNodes #### 功能介绍 查询节点列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dws/dws_02_0062.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dws/dws_02_0056.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dws:cluster:listNode | List | cluster \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI GET /v2/{project_id}/clusters/{cluster_id}/nodes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-dws/dws_02_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | cluster_id | 是 | String | **参数解释**： 集群ID。获取方法请参见[获取集群ID](https://support.huaweicloud.com/api-dws/dws_02_00068.html)。 **约束限制**： 必须是有效的dws集群ID。 **取值范围**： 36位UUID。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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的整数。 | 表4ClusterNodeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 节点ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 节点名称。 **取值范围**： 不涉及。 | | status | String | **参数解释**： 节点状态。 **取值范围**： - CREATING：创建中。 - FREE：空闲。 - ACTIVE：正常。 - FAILED：不可用。 - CREATE_FAILED：创建失败。 - DELETING：删除中。 - FROZEN：冻结。 - STOPPED：关机。 | | sub_status | String | **参数解释**： 节点子状态。 **取值范围**： - READY：ECS已就绪。 - PREPARED：软件已部署。 - INITED：节点已正常。 - CREATED：节点已监控。 | | 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 ``` #### 响应示例 **状态码：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代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dws.DwsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dws.NewDwsClient(hcClient) request := &model.ListClusterNodesRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListClusterNodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DWS/sdk?api=ListClusterNodes)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询集群节点信息成功。 | | 400 | 请求错误。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 500 | 服务内部错误。 | | 503 | 服务不可用。 |