Nodes info

Represents mostly static information about your cluster’s nodes, including but not limited to:

  • Host system information
  • JVM
  • Processor Type
  • Node settings
  • Thread pools settings
  • Installed plugins

Example

To get information on all nodes in a cluster:

  1. GET /_nodes

To get thread pool information from the cluster manager node only:

  1. GET /_nodes/master:true/thread_pool?pretty

Path and HTTP methods

  1. GET /_nodes
  2. GET /_nodes/{nodeId}
  3. GET /_nodes/{metrics}
  4. GET /_nodes/{nodeId}/{metrics}
  5. # or full path equivalent
  6. GET /_nodes/{nodeId}/info/{metrics}

URL parameters

You can include the following URL parameters in your request. All parameters are optional.

ParameterTypeDescription
nodeIdStringA comma-separated list of nodeIds to filter results. Supports node filters. Defaults to _all.
metricsStringA comma-separated list of metric groups that will be included in the response. For example jvm,thread_pools. Defaults to all metrics.
timeoutTimeValueA request timeout. Defaults to 30s.

The following are listed for all available metric groups:

MetricDescription
settingsA node’s settings. This is combination of the default settings, custom settings from configuration file and dynamically updated settings.
osStatic information about the host OS, including version, processor architecture and available/allocated processors.
processContains process OD.
jvmDetailed static information about running JVM, including arguments.
thread_poolConfigured options for all individual thread pools.
transportMostly static information about the transport layer.
httpMostly static information about the HTTP layer.
pluginsInformation about installed plugins and modules.
ingestInformation about ingest pipelines and available ingest processors.
aggregationsInformation about available aggregations.
indicesStatic index settings configured at the node level.

Response

The response contains basic node identification and build info for every node matching the {nodeId} request parameter.

MetricDescription
nameA node name.
transport_addressA node transport address.
hostA node host address.
ipA node host ip address.
versionA node OpenSearch version.
build_typeA build type, like rpm,docker, zip, etc.
build_hashA git commit hash of the build.
rolesA node’s role.
attributesA node attributes.

The response also contains one or more metric groups, depending on the {metrics} request parameter.

  1. GET /_nodes/master:true/process,transport?pretty
  3. {
  4.   "_nodes": {
  5.     "total": 1,
  6.     "successful": 1,
  7.     "failed": 0
  8.   },
  9.   "cluster_name": "opensearch",
  10.   "nodes": {
  11.     "VC0d4RgbTM6kLDwuud2XZQ": {
  12.       "name": "node-m1-23",
  13.       "transport_address": "127.0.0.1:9300",
  14.       "host": "127.0.0.1",
  15.       "ip": "127.0.0.1",
  16.       "version": "1.3.1",
  17.       "build_type": "tar",
  18.       "build_hash": "c4c0672877bf0f787ca857c7c37b775967f93d81",
  19.       "roles": [
  20.         "data",
  21.         "ingest",
  22.         "master",
  23.         "remote_cluster_client"
  24.       ],
  25.       "attributes": {
  26.         "shard_indexing_pressure_enabled": "true"
  27.       },
  28.       "process" : {
  29.         "refresh_interval_in_millis": 1000,
  30.         "id": 44584,
  31.         "mlockall": false
  32.       },
  33.       "transport": {
  34.         "bound_address": [
  35.           "[::1]:9300",
  36.           "127.0.0.1:9300"
  37.         ],
  38.         "publish_address": "127.0.0.1:9300",
  39.         "profiles": { }
  40.       }
  41.     }
  42.   }
  43. }

Required permissions

If you use the security plugin, make sure you have the appropriate permissions: cluster:monitor/nodes/info.