You're viewing version 2.18 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
CAT nodes
Introduced 1.0
The CAT nodes operation lists node-level information, including node roles and load metrics.
A few important node metrics are pid, name, cluster_manager, ip, port, version, build, jdk, along with disk, heap, ram, and file_desc.
Endpoints
GET /_cat/nodes
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
bytes | String | The units used to display byte values. Valid values are: b, kb, k, mb, m, gb, g, tb, t, pb, p | N/A |
cluster_manager_timeout | String | The amount of time allowed to establish a connection to the cluster manager node. | N/A |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
full_id | Boolean or String | When true, returns the full node ID. When false, returns the shortened node ID. | false |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
time | String | Specifies the time units, for example, 5d or 7h. For more information, see Supported units. Valid values are: nanos, micros, ms, s, m, h, d | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
Example request
The following example request lists node level information:
GET _cat/nodes?v
Example response
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