文档首页> MapReduce服务 MRS> API参考> API V2> 集群管理接口> 查询集群节点列表
更新时间：2024-06-03 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询集群节点列表

功能介绍

查询集群节点列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

cluster_id

是

String

集群ID。
表2 Query参数

参数

是否必选

参数类型

描述

node_group

否

String

要查询的节点组名称。

limit

否

Integer

返回结果中每页显示条数。缺省值：10。

offset

否

Integer

表示作业列表从该偏移量开始查询。缺省值：1。

node_name

否

String

指定节点名称，支持模糊搜索。

sort_key

否

String

排序键，支持对节点名称排序。

sort_dir

否

String

列表排序方式，desc为降序，asc为升序。

query_node_detail

否

Boolean

是否查询节点详情。该字段设为true时可能会影响接口性能。

query_ecs_detail

否

Boolean

是否查询ECS详情信息，会涉及对ECS接口调用。

internal_ip

否

String

指定内网IP。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

nodes

Array of ClusterNode objects

节点列表。

node_total

Integer

节点数。
表4 ClusterNode

参数

参数类型

描述

node_name

String

节点名称，对应manager里的节点名称。

resource_id

String

资源id。确定节点的唯一性，包周期节点可用于计费的查询。

node_group_name

String

节点组名称。

node_type

String

节点类型。Task、Core、Master等。

billing_type

String

on-period包周期或者on-quantity按需。

deployment_type

String

部署类型。支持Server主机类型。

server_info

ServerInfo object

如果部署类型为Server类型，则该字段不为空。

tags

Array of Tag objects

节点标签

node_detail

NodeDetail object

节点监控信息。需要IAM同步后才能返回。

node_status

String

节点状态。对应页面上的操作状态。

component_infos

Array of ComponentInfo objects

组件实例信息数组。
表5 ServerInfo

参数

参数类型

描述

server_id

String

服务器ID。

server_name

String

服务器名称。

server_type

String

ECS或者BMS。

data_volumes

Array of VolumeInfo objects

数据盘。

root_volume

VolumeInfo object

系统盘。

cpu_type

String

CPU类型。x86或者ARM。

cpu

String

CPU大小。

mem

String

内存大小。

internal_ip

String

内部IP。
表6 VolumeInfo

参数

参数类型

描述

type

String

磁盘类型。

  • SATA：普通IO磁盘类型。

  • SAS：高IO磁盘类型。

  • SSD：超高IO磁盘类型。

  • GPSSD：通用型SSD磁盘类型

size

Integer

磁盘大小。单位为GB。

count

Integer

磁盘数量。
表7 Tag

参数

参数类型

描述

key

String

标签键。

value

String

标签值。
表8 NodeDetail

参数

参数类型

描述

running_status

String

运行状态。

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。
表9 ComponentInfo

参数

参数类型

描述

id

String

组件ID。

name

String

组件名。

instance_group_name

String

组件所在组名称。

running_status

String

运行状态。

ha_status

String

HA状态。

config_status

String

配置状态。

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

是否支持收集堆栈信息。

请求示例

查询集群指定节点组的节点列表。

/v2/174ee662a7e24cc99bfc858c4558dbf6/clusters/f0a91b14-8884-4ba1-9e8d-0a21086c0ab4/nodes?node_group=master_node_default_group

响应示例

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

状态码

状态码

描述

200

查询的节点列表信息。

错误码

请参见错误码。

父主题： 集群管理接口
分享：

    相关文档

    相关产品