Files
OpenSearch-Docs-Cn/_api-reference/cat/cat-nodes.md
T

55 lines
1.9 KiB
Markdown
Raw Normal View History

2021-06-21 23:13:40 -07:00
---
layout: default
title: CAT nodes operation
parent: CAT API
2022-10-27 11:50:39 -05:00
2021-06-21 23:13:40 -07:00
nav_order: 40
has_children: false
2023-05-04 11:22:52 -07:00
redirect_from:
- /opensearch/rest-api/cat/cat-nodes/
2021-06-21 23:13:40 -07:00
---
# CAT nodes
**Introduced 1.0**
2021-07-26 16:14:22 -07:00
{: .label .label-purple }
2021-06-21 23:13:40 -07:00
The CAT nodes operation lists node-level information, including node roles and load metrics.
2021-06-21 23:13:40 -07:00
A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
2021-06-21 23:13:40 -07:00
## Example
```
GET _cat/nodes?v
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
## Path and HTTP methods
```
GET _cat/nodes
```
## URL parameters
All CAT nodes URL parameters are optional.
2021-06-21 23:13:40 -07:00
2022-10-27 11:50:39 -05:00
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
2021-06-21 23:13:40 -07:00
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
full_id | Boolean | If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
2021-06-21 23:13:40 -07:00
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
## Response
```json
2022-12-06 14:52:33 -07:00
ip | heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles | cluster_manager | name
10.11.1.225 | 31 | 32 | 0 | 0.00 | 0.00 | di | data,ingest,ml | - | data-e5b89ad7
2021-06-21 23:13:40 -07:00
```