节点信息
1.0 版引入
节点信息 API 主要提供集群节点的相关静态信息，包括但不限于：
- 主机系统信息
- JVM
- 处理器类型
- 节点设置
- 线程池设置
- 已安装插件
端点
GET /_nodes
GET /_nodes/<nodeId>
GET /_nodes/<metrics>
GET /_nodes/<nodeId>/<metrics>
# or full path equivalent
GET /_nodes/<nodeId>/info/<metrics>
路径参数
下表列出了可用的路径参数。所有路径参数均为可选。
| 参数 | 类型 | 描述 |
|---|---|---|
| nodeId | 字符串 | 用于筛选结果的 nodeId 逗号分隔列表。支持节点过滤器。默认为 _all。 |
| metrics | 字符串 | 响应中将包含的指标组的逗号分隔列表。例如，jvm,thread_pool。默认为所有指标。 |
下表列出了所有可用的度量组。
| 度量 | 描述 |
|---|---|
| settings | 节点的设置。这是默认设置、来自配置文件的自定义设置和动态更新设置的组合。 |
| 操作系统 | 关于主机操作系统的静态信息，包括版本、处理器架构以及可用/已分配的处理器数量。 |
| 进程 | 包含进程 ID。 |
| JVM | 关于运行中 JVM 的详细静态信息，包括参数。 |
| thread_pool | 所有独立线程池的配置选项。 |
| transport | 关于传输层的大部分静态信息。 |
| http | 关于 HTTP 层的大部分静态信息。 |
| plugins | 关于已安装插件和模块的信息。 |
| 摄取 | 关于摄入管道和可用摄入处理器信息。 |
| aggregations | 关于可用聚合的信息。 |
| 索引 | 在节点级别配置的静态索引设置。 |
查询参数
您可以在请求中包含以下查询参数。所有查询参数都是可选的。
| 参数 | 类型 | 描述 |
|---|---|---|
| flat_settings | 布尔型 | 指定是否以扁平格式返回响应的 settings 对象。默认为 false。 |
| timeout | 时间 | 设置节点响应的时间限制。默认值为 30s。 |
请求示例
以下查询从集群管理器节点请求 process 和 transport 指标
GET /_nodes/cluster_manager:true/process,transport
仅获取集群管理器节点的线程池信息，请使用以下查询
GET /_nodes/master:true/thread_pool
示例响应
响应包含 <metrics> 请求参数中指定的指标组（在本例中为 process 和 transport）
{
"_nodes": {
"total": 1,
"successful": 1,
"failed": 0
},
"cluster_name": "opensearch",
"nodes": {
"VC0d4RgbTM6kLDwuud2XZQ": {
"name": "node-m1-23",
"transport_address": "127.0.0.1:9300",
"host": "127.0.0.1",
"ip": "127.0.0.1",
"version": "1.3.1",
"build_type": "tar",
"build_hash": "c4c0672877bf0f787ca857c7c37b775967f93d81",
"roles": [
"data",
"ingest",
"master",
"remote_cluster_client"
],
"attributes": {
"shard_indexing_pressure_enabled": "true"
},
"process" : {
"refresh_interval_in_millis": 1000,
"id": 44584,
"mlockall": false
},
"transport": {
"bound_address": [
"[::1]:9300",
"127.0.0.1:9300"
],
"publish_address": "127.0.0.1:9300",
"profiles": { }
}
}
}
}
响应正文字段
响应包含与 <nodeId> 请求参数匹配的每个节点的基本节点标识和构建信息。下表列出了响应字段。
| 字段 | 描述 |
|---|---|
| 名称 | 节点的名称。 |
| transport_address | 节点的传输地址。 |
| host | 节点的主机地址。 |
| ip | 节点的主机 IP 地址。 |
| version | 节点的 OpenSearch 版本。 |
| build_type | 节点的构建类型，例如 rpm、docker、tar 等。 |
| build_hash | 构建的 Git 提交哈希。 |
| total_indexing_buffer | 用于保存新索引文档的最大堆大小（以字节为单位）。一旦超出此堆大小，文档将被写入磁盘。 |
| roles | 节点的角色列表。 |
| attributes | 节点的属性。 |
| 操作系统 | 关于操作系统的信息，包括名称、版本、架构、刷新间隔以及可用和已分配处理器的数量。 |
| 进程 | 关于当前运行进程的信息，包括 PID、刷新间隔和 mlockall，其中 mlockall 指定进程地址空间是否已成功锁定在内存中。 |
| JVM | 关于 JVM 的信息，包括 PID、版本、内存信息、垃圾收集器信息和参数。 |
| thread_pool | 关于线程池的信息。 |
| transport | 关于传输地址的信息，包括绑定地址、发布地址和配置文件。 |
| http | 关于 HTTP 地址的信息，包括绑定地址、发布地址和最大内容长度（以字节为单位）。 |
| plugins | 关于已安装插件的信息，包括名称、版本、OpenSearch 版本、Java 版本、描述、类名、自定义文件夹名称、扩展插件列表以及 has_native_controller，其中 has_native_controller 指定插件是否具有原生控制器进程。 |
| modules | 关于模块的信息，包括名称、版本、OpenSearch 版本、Java 版本、描述、类名、自定义文件夹名称、扩展插件列表以及 has_native_controller，其中 has_native_controller 指定插件是否具有原生控制器进程。模块与插件不同，因为模块会自动加载到 OpenSearch 中，而插件则需要手动安装。 |
| 摄取 | 关于摄入管道和处理器信息。 |
| aggregations | 关于可用聚合类型的信息。 |
所需权限
如果您使用安全插件，请确保您拥有相应的权限：cluster:monitor/nodes/info。