Link Search Menu Expand Document Documentation Menu

You're viewing version 2.8 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.

Nodes API

The nodes API makes it possible to retrieve information about individual nodes within your cluster.

Node filters

Use the <node-filters> parameter to filter the target set of nodes in the API response.

Parameter Type Description
<node-filters> String A comma-separated list of resolution mechanisms that OpenSearch uses to identify cluster nodes.

Node filters support several node resolution mechanisms:

  • Predefined constants: _local, _cluster_manager, or _all.
  • An exact match for nodeID
  • A simple case-sensitive wildcard pattern matching for node-name, host-name, or host-IP-address.
  • Node roles where the <bool> value is set either to true or false:
    • cluster_manager:<bool> refers to all cluster manager-eligible nodes.
    • data:<bool> refers to all data nodes.
    • ingest:<bool> refers to all ingest nodes.
    • voting_only:<bool> refers to all voting-only nodes.
    • ml:<bool> refers to all machine learning (ML) nodes.
    • coordinating_only:<bool> refers to all coordinating-only nodes.
  • A simple case-sensitive wildcard pattern matching for node attributes: <node attribute*>:<attribute value*>. The wildcard matching pattern can be used in both the key and value at the same time.

Resolution mechanisms are applied sequentially in the order specified by the client. Each mechanism specification can either add or remove nodes.

To get statistics from the elected cluster manager node only, use the following query :

GET /_nodes/_cluster_manager/stats

To get statistics from nodes that are data-only nodes, use the following query:

GET /_nodes/data:true/stats

Order of resolution mechanisms

The order of resolution mechanisms is applied sequentially, and each can add or remove nodes. The following examples yield different results.

To get statistics from all the nodes except the cluster manager node, use the following query:

GET /_nodes/_all,cluster_manager:false/stats

However, if you switch the resolution mechanisms, the result will include all the cluster nodes, including the cluster manager node:

GET /_nodes/cluster_manager:false,_all/stats

Related articles

350 characters left

Have a question? .

Want to contribute? or .