This version of the OpenSearch documentation 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.

Example

  1. GET _cat/nodes?v

copy

Path and HTTP methods

  1. GET _cat/nodes

URL parameters

All CAT nodes URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

ParameterTypeDescription
bytesByte sizeSpecify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units.
full_idBooleanIf true, return the full node ID. If false, return the shortened node ID. Defaults to false.
localBooleanWhether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeoutTimeThe amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
timeTimeSpecify the units for time. For example, 5d or 7h. For more information, see Supported units.
include_unloaded_segmentsBooleanWhether to include information from segments not loaded into memory. Default is false.

Response

  1. ip       |   heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | node.roles |     cluster_manager |  name
  2. 10.11.1.225  |         31   |    32  | 0  |  0.00  |  0.00   | di  | data,ingest,ml  | - |  data-e5b89ad7