# 查询集群节点列表-ListNodes #### 功能介绍 查询指定MRS集群的节点列表信息，包括节点名称、IP地址、节点类型和运行状态等，用于了解集群的节点组成和各节点的运行情况。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-mrs/zh-cn_topic_0013582897.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-mrs/mrs_02_0221.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/clusters/{cluster_id}/nodes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目编号。获取方法，请参见[获取项目ID](https://support.huaweicloud.com/api-mrs/mrs_02_0011.html)。 **约束限制：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | cluster_id | 是 | String | **参数解释：** 集群ID。如果指定集群ID，则获取该集群做过补丁更新的最新版本元数据。获取方法，请参见[获取集群ID](https://support.huaweicloud.com/api-mrs/mrs_02_9001.html#mrs_02_9001__zh-cn_topic_0264280065_section177891315153619)。 **约束限制：** 只能由英文字母、数字以及"_"和"-"组成，且长度为\[1-64\]个字符。 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_group | 否 | String | **参数解释：** 要查询的节点组名称。 **约束限制：** 不涉及 **取值范围：** 只能由小写字母（a-z）、大写字母（A-Z）、数字（0-9）以及下划线（_）组成，除系统默认节点组外，自定义节点组名称长度为3\~14个字符。 **默认取值：** 不涉及 | | limit | 否 | Integer | **参数解释：** 返回结果中每页显示条数。 **约束限制：** 不涉及 **取值范围：** 1\~1000 **默认取值：** 10 | | offset | 否 | Integer | **参数解释：** 表示节点列表从该偏移量开始查询，与limit配合使用。假如共有30个节点，设置offset为1，limit为10，即为从第12个节点开始查询，一次最多可读取10个节点。 **约束限制：** 不涉及 **取值范围：** 大于等于1，且小于MRS集群节点总数。 **默认取值：** 不涉及 | | node_name | 否 | String | **参数解释：** 指定节点名称，支持模糊搜索。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sort_key | 否 | String | **参数解释：** 排序键，支持对节点名称排序。 **约束限制：** 不涉及 **取值范围：** - node_name：节点名称 **默认取值：** 不涉及 | | sort_dir | 否 | String | **参数解释：** 列表排序方式，desc为降序，asc为升序（均为小写）。 **约束限制：** 不涉及 **取值范围：** - desc：降序排列 - asc：升序排列 **默认取值：** 不涉及 | | query_node_detail | 否 | Boolean | **参数解释：** 是否查询节点详情。该字段设为true时可能会影响接口性能。 **约束限制：** 不涉及 **取值范围：** - true：查询节点详情 - false：不查询节点详情 **默认取值：** false | | query_ecs_detail | 否 | Boolean | **参数解释：** 是否查询ECS详情信息，会涉及对ECS接口调用。 **约束限制：** 不涉及 **取值范围：** - true：查询ECS详情信息 - false：不查询ECS详情信息 **默认取值：** false | | internal_ip | 否 | String | **参数解释：** 指定节点内网IP地址。 **约束限制：** 不涉及 **取值范围：** 只能由数字和点组成，符合IP地址格式，长度为7\~15个字符。 **默认取值：** 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | nodes | Array of [ClusterNode] objects | **参数解释：** 节点列表。 每个节点返回其对应对象结构，其中包括node_name、resource_id等详细信息。 | | node_total | Integer | **参数解释：** 节点数。 **取值范围：** 不涉及 | 表4ClusterNode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | node_name | String | **参数解释：** 节点名称，对应Manager里的节点名称。 **取值范围：** 不涉及 | | resource_id | String | **参数解释：** 资源id。确定节点的唯一性，包周期节点可用于计费的查询。 **取值范围：** 不涉及 | | node_group_name | String | **参数解释：** 节点组名称。 **取值范围：** 不涉及 | | node_type | String | **参数解释：** 节点类型。Task、Core、Master等。 **取值范围：** 集群一定包含Master节点，Core节点与Task节点可能存在 - Master：Master节点 - Core：Core节点 - Task：Task节点 | | billing_type | String | **参数解释：** on-period包周期或者on-quantity按需。 **取值范围：** - on-period：包周期计费。 - on-quantity：按需计费。 | | deployment_type | String | **参数解释：** 部署类型。支持Server主机类型。 **取值范围：** - SERVER：主机类型 | | server_info | [ServerInfo] object | **参数解释：** 如果部署类型为Server类型，则该字段不为空。 包含节点上的磁盘信息及节点类型等信息，详细参数说明请参考参数详情列表。 | | tags | Array of [Tag] objects | **参数解释：** 当前节点上绑定的标签键值对，详细参数说明请参考参数详情列表。 | | node_detail | [NodeDetail] object | **参数解释：** 节点监控信息。需要IAM同步后才能返回，详细参数说明请参考参数详情列表。 | | node_status | String | **参数解释：** 节点状态。对应页面上的操作状态。 **取值范围：** - error：故障。 - delete_fail：删除失败。 - shutdown：关机。 - creating：创建中。 - starting：启动中。 - started：运行中。 - deleting：删除中。 - powering-on：正在开机。 - powering-off：正在关机。 - stopping：停止中。 - attaching：解除隔离中。 - attached：已解除隔离。 - detaching：隔离中。 - detached：已隔离。 - detached_no_subscription：已解绑。 - detach_fail：隔离失败。 - destroyed：已删除。 - lost：失联。 - unknown：未知。 - scaling-up：规格升级中。 - decommissioning：节点退服中。 - decommissioned：节点已退服。 - recommissioning：节点入服中。 - decommission_fail：节点退服失败。 - restore_fail：修复失败。 | | component_infos | Array of [ComponentInfo] objects | **参数解释：** 组件实例信息数组，详细参数说明请参考参数详情列表。 | 表5ServerInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | server_id | String | **参数解释：** 服务器ID。 **取值范围：** 不涉及 | | server_name | String | **参数解释：** 服务器名称。 **取值范围：** 不涉及 | | server_type | String | **参数解释：** 服务器类型。ECS或者BMS。 **取值范围：** - ECS：弹性云服务器 - BMS：裸金属服务器 | | data_volumes | Array of [VolumeInfo] objects | **参数解释：** 数据盘。 **取值范围：** 不涉及 | | root_volume | [VolumeInfo] object | **参数解释：** 系统盘。 **取值范围：** 不涉及 | | cpu_type | String | **参数解释：** CPU类型。x86或者ARM。 **取值范围：** - X86：X86计算机架构 - ARM：ARM计算机架构 | | cpu | String | **参数解释：** CPU大小，单位为核。 **取值范围：** 不涉及 | | mem | String | **参数解释：** 内存大小，单位为MB。 **取值范围：** 不涉及 | | internal_ip | String | **参数解释：** 内部IP。 **取值范围：** 不涉及 | 表6VolumeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 磁盘类型。 **取值范围：** - SATA：普通IO磁盘类型。 - SAS：高IO磁盘类型。 - SSD：超高IO磁盘类型。 - GPSSD：通用型SSD磁盘类型。 | | size | Integer | **参数解释：** 磁盘大小。单位为GB。 **取值范围：** 不涉及 | | count | Integer | **参数解释：** 磁盘数量。 **取值范围：** 不涉及 | 表7Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** 不涉及 | | value | String | **参数解释：** 标签值。 **取值范围：** 不涉及 | 表8NodeDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | running_status | String | **参数解释：** 运行状态。 **取值范围：** - GOOD：良好 - BAD：故障 - UNKNOWN：未知 - CONCERNING：恢复中 - ISOLATED：已隔离 - SUSPENDED：已停机 | | cpu_usage | String | **参数解释：** CPU使用率，单位为百分比。 **取值范围：** 不涉及 | | memory_usage | String | **参数解释：** 内存使用率，单位为百分比。 **取值范围：** 不涉及 | | disk_usage | String | **参数解释：** 硬盘使用率，单位为百分比。 **取值范围：** 不涉及 | | total_memory | String | **参数解释：** 总内存。单位MB。 **取值范围：** 不涉及 | | available_memory | String | **参数解释：** 可用内存。单位MB。 **取值范围：** 不涉及 | | total_hard_disk_space | String | **参数解释：** 总硬盘空间。单位GB。 **取值范围：** 不涉及 | | available_hard_disk_space | String | **参数解释：** 可用硬盘空间。单位GB。 **取值范围：** 不涉及 | | network_read | String | **参数解释：** 网络读取速度。单位Byte/s。 **取值范围：** 不涉及 | | network_write | String | **参数解释：** 网络写入速度。单位Byte/s。 **取值范围：** 不涉及 | 表9ComponentInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 组件ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 组件名。 **取值范围：** 不涉及 | | instance_group_name | String | **参数解释：** 组件所在组名称。 **取值范围：** 不涉及 | | running_status | String | **参数解释：** 运行状态。 **取值范围：** - GOOD：良好 - BAD：故障 - UNKNOWN：未知 - CONCERNING：恢复中 - ISOLATED：已隔离 - SUSPENDED：已停机 | | ha_status | String | **参数解释：** HA状态。 **取值范围：** - ACTIVE：主 - STANDBY：备 - OBSERVER：从 - UNKNOWN：未知 | | config_status | String | **参数解释：** 配置状态。 **取值范围：** - SYNCHRONIZED：已同步 - EXPIRED：配置超期 - FAILED：配置失败 - CONFIGURING：配置中 - UNKNOWN：未知 | | role_name | String | **参数解释：** 角色名。 **取值范围：** 不涉及 | | role_short_name | String | **参数解释：** 角色缩写。 **取值范围：** 不涉及 | | role_type | String | **参数解释：** 角色类型。 **取值范围：** 不涉及 | | service_name | String | **参数解释：** 服务名。 **取值范围：** 不涉及 | | pair_name | String | **参数解释：** 对名。 **取值范围：** 不涉及 | | relation_pairs | String | **参数解释：** 关联对。 **取值范围：** 不涉及 | | support_decom | String | **参数解释：** 是否支持Decom。 **取值范围：** 不涉及 | | support_reinstall | String | **参数解释：** 是否支持重装。 **取值范围：** 不涉及 | | support_collect_stack_info | String | **参数解释：** 是否支持收集堆栈信息。 **取值范围：** 不涉及 | #### 请求示例 查询集群指定节点组的节点列表。 ``` https://mrs.cn-north-7.myhuaweicloud.com/v2/174ee662a7e24cc99bfc858c4558dbf6/clusters/f0a91b14-8884-4ba1-9e8d-0a21086c0ab4/nodes?node_group=master_node ``` #### 响应示例 **状态码：200** 查询的节点列表信息。 ``` { "nodes" : [ { "node_name" : "node-master1QxCW", "resource_id" : "fc1ed6bb-e3d8-4dc8-8162-ef673bff6b7b", "node_group_name" : "master_node_default_group", "node_type" : "Master", "billing_type" : "on-quantity", "deployment_type" : "SERVER", "server_info" : { "server_id" : "3687f50a-cd4e-4c67-8858-5d6555c8834c", "server_name" : "f28fb043-ecbc-401e-936e-fb321ca8d40a_node_master1QxCW", "server_type" : "ECS", "data_volumes" : [ { "type" : "SATA", "size" : 200, "count" : 1 } ], "root_volume" : { "type" : "SATA", "size" : 100, "count" : 1 }, "cpu_type" : "X86", "internal_ip" : "192.168.10.142" }, "tags" : [ { "key" : "1", "value" : "2" } ], "node_status" : "started" } ], "node_total" : 1 } ``` #### 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.mrs.v2.region.MrsRegion; import com.huaweicloud.sdk.mrs.v2.*; import com.huaweicloud.sdk.mrs.v2.model.*; public class ListNodesSolution { 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); MrsClient client = MrsClient.newBuilder() .withCredential(auth) .withRegion(MrsRegion.valueOf("")) .build(); ListNodesRequest request = new ListNodesRequest(); request.withClusterId("{cluster_id}"); try { ListNodesResponse response = client.listNodes(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 huaweicloudsdkmrs.v2.region.mrs_region import MrsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmrs.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 = MrsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MrsRegion.value_of("")) \ .build() try: request = ListNodesRequest() request.cluster_id = "{cluster_id}" response = client.list_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" mrs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/mrs/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 := mrs.MrsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := mrs.NewMrsClient(hcClient) request := &model.ListNodesRequest{} request.ClusterId = "{cluster_id}" response, err := client.ListNodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/MRS/sdk?api=ListNodes&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询的节点列表信息。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-mrs/ErrorCode.html)。