Get node information | Elasticsearch API documentation

Get node information Generally available; Added in 1.3.0

GET /_nodes/{node_id}/{metric}

Api key auth Basic auth Bearer auth

All methods and paths for this operation:

GET /_nodes

GET /_nodes/{metric}

GET /_nodes/{node_id}

GET /_nodes/{node_id}/{metric}

By default, the API returns all attributes and core settings for cluster nodes.

Path parameters

node_id string | array[string] Required

Comma-separated list of node IDs or names used to limit returned information.
metric string | array[string] Required

Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

Query parameters

flat_settings boolean

If true, returns settings in flat format.
timeout string

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Values are -1 or 0.

Responses

200 application/json
details#setActive"> Hide response attributes Show response attributes object
- _nodes object
  
  Contains statistics about the number of nodes selected by the request.
  
  details#setActive"> Hide _nodes attributes Show _nodes attributes object
  
  failures array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  details#setActive"> Hide failures attributes Show failures attributes object
  
  type string Required
  
  The type of error
  
  reason string | null
  
  A human-readable explanation of the error, in English.
  
  alternative#change alternative:form->explorer-send-request#updateRequest" data-tabs-scroll="true">
  One of:
  tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-_nodes-failures-reason" role="tab" aria-controls="operation-nodes-info-200-body-application-json-_nodes-failures-reason" tabindex="0"> string-1 string tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-_nodes-failures-string-2-reason-string-null" role="tab" aria-controls="operation-nodes-info-200-body-application-json-_nodes-failures-string-2-reason-string-null" tabindex="0"> string-2 string | null
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  root_cause array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  suppressed array[object]
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  
  total number Required
  
  Total number of nodes selected by the request.
  
  successful number Required
  
  Number of nodes that responded successfully to the request.
  
  failed number Required
  
  Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
- cluster_name string Required
- nodes object Required
  
  details#setActive"> Hide nodes attribute Show nodes attribute object
  
  * object Additional properties
  
  details#setActive"> Hide * attributes Show * attributes object
  
  attributes object Required
  
  details#setActive"> Hide attributes attribute Show attributes attribute object
  
  * string Additional properties
  
  build_flavor string Required
  
  build_hash string Required
  
  Short hash of the last git commit in this release.
  
  build_type string Required
  
  component_versions object Required
  
  details#setActive"> Hide component_versions attribute Show component_versions attribute object
  
  * number Additional properties
  
  host string Required
  
  http object
  
  details#setActive"> Hide http attributes Show http attributes object
  
  bound_address array[string] Required
  
  max_content_length number | string
  
  alternative#change alternative:form->explorer-send-request#updateRequest" data-tabs-scroll="true">
  One of:
  tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes-http" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes-http" tabindex="0"> number-1 number tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes-http-string-2-string" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes-http-string-2-string" tabindex="0"> string-2 string
  
  max_content_length_in_bytes number Required
  
  publish_address string Required
  
  index_version number Required
  
  ip string Required
  
  jvm object
  
  details#setActive"> Hide jvm attributes Show jvm attributes object
  
  gc_collectors array[string] Required
  
  mem object Required
  
  details#setActive"> Hide mem attributes Show mem attributes object
  
  direct_max
  
  direct_max_in_bytes number Required
  
  heap_init
  
  heap_init_in_bytes number Required
  
  heap_max
  
  heap_max_in_bytes number Required
  
  non_heap_init
  
  non_heap_init_in_bytes number Required
  
  non_heap_max
  
  non_heap_max_in_bytes number Required
  
  memory_pools array[string] Required
  
  pid number Required
  
  Time unit for milliseconds
  
  version string Required
  
  vm_name string Required
  
  vm_vendor string Required
  
  vm_version string Required
  
  using_bundled_jdk boolean Required
  
  using_compressed_ordinary_object_pointers boolean | string
  
  alternative#change alternative:form->explorer-send-request#updateRequest" data-tabs-scroll="true">
  One of:
  tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes-jvm-using_compressed_ordinary_object_pointers" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes-jvm-using_compressed_ordinary_object_pointers" tabindex="0"> boolean-1 boolean tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes-jvm-string-2-using_compressed_ordinary_object_pointers-string" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes-jvm-string-2-using_compressed_ordinary_object_pointers-string" tabindex="0"> string-2 string
  
  input_arguments array[string] Required
  
  name string Required
  
  os object
  
  details#setActive"> Hide os attributes Show os attributes object
  
  arch string Required
  
  Name of the JVM architecture (ex: amd64, x86)
  
  available_processors number Required
  
  Number of processors available to the Java virtual machine
  
  allocated_processors number
  
  The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.
  
  name string Required
  
  pretty_name string Required
  
  Time unit for milliseconds
  
  version string Required
  
  cpu object
  
  details#setActive"> Hide cpu attributes Show cpu attributes object
  
  cache_size string Required
  
  cache_size_in_bytes number Required
  
  cores_per_socket number Required
  
  mhz number Required
  
  model string Required
  
  total_cores number Required
  
  total_sockets number Required
  
  vendor string Required
  
  mem object
  
  details#setActive"> Hide mem attributes Show mem attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  swap object
  
  details#setActive"> Hide swap attributes Show swap attributes object
  
  total string Required
  
  total_in_bytes number Required
  
  plugins array[object]
  
  details#setActive"> Hide plugins attributes Show plugins attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  process object
  
  details#setActive"> Hide process attributes Show process attributes object
  
  id number Required
  
  Process identifier (PID)
  
  mlockall boolean Required
  
  Indicates if the process address space has been successfully locked in memory
  
  Time unit for milliseconds
  
  roles array[string] Required
  
  Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
  
  settings object
  
  details#setActive"> Hide settings attributes Show settings attributes object
  
  cluster object Required
  
  details#setActive"> Hide cluster attributes Show cluster attributes object
  
  name string Required
  
  routing object
  
  election object Required
  
  initial_master_nodes
  
  deprecation_indexing object
  
  node object Required
  
  details#setActive"> Hide node attributes Show node attributes object
  
  name string Required
  
  attr object Required
  
  max_local_storage_nodes string
  
  path object
  
  details#setActive"> Hide path attributes Show path attributes object
  
  logs string
  
  home string
  
  repo array[string]
  
  data
  
  repositories object
  
  details#setActive"> Hide repositories attribute Show repositories attribute object
  
  url object Required
  
  discovery object
  
  details#setActive"> Hide discovery attributes Show discovery attributes object
  
  seed_hosts
  
  type string
  
  seed_providers array[string]
  
  action object
  
  details#setActive"> Hide action attribute Show action attribute object
  
  destructive_requires_name string Required
  
  client object
  
  details#setActive"> Hide client attribute Show client attribute object
  
  type string Required
  
  http object Required
  
  details#setActive"> Hide http attributes Show http attributes object
  
  type object Required
  
  type.default string
  
  compression
  
  port
  
  bootstrap object
  
  details#setActive"> Hide bootstrap attribute Show bootstrap attribute object
  
  memory_lock string Required
  
  transport object Required
  
  details#setActive"> Hide transport attributes Show transport attributes object
  
  type object Required
  
  type.default string
  
  features object
  
  network object
  
  details#setActive"> Hide network attribute Show network attribute object
  
  host
  
  xpack object
  
  details#setActive"> Hide xpack attributes Show xpack attributes object
  
  license object
  
  security object Required
  
  notification object
  
  ml object
  
  script object
  
  details#setActive"> Hide script attributes Show script attributes object
  
  allowed_types string Required
  
  disable_max_compilations_rate string
  
  search object
  
  details#setActive"> Hide search attribute Show search attribute object
  
  remote object Required
  
  ingest object
  
  details#setActive"> Hide ingest attributes Show ingest attributes object
  
  attachment object
  
  append object
  
  csv object
  
  convert object
  
  date object
  
  date_index_name object
  
  dot_expander object
  
  enrich object
  
  fail object
  
  foreach object
  
  json object
  
  user_agent object
  
  kv object
  
  geoip object
  
  grok object
  
  gsub object
  
  join object
  
  lowercase object
  
  remove object
  
  rename object
  
  script object
  
  set object
  
  sort object
  
  split object
  
  trim object
  
  uppercase object
  
  urldecode object
  
  bytes object
  
  dissect object
  
  set_security_user object
  
  pipeline object
  
  drop object
  
  circle object
  
  inference object
  
  thread_pool object
  
  details#setActive"> Hide thread_pool attribute Show thread_pool attribute object
  
  * object Additional properties
  
  details#setActive"> Hide * attributes Show * attributes object
  
  core number
  
  keep_alive string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  
  max number
  
  queue_size number Required
  
  size number
  
  type string Required
  
  total_indexing_buffer number
  
  Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.
  
  total_indexing_buffer_in_bytes number | string
  
  alternative#change alternative:form->explorer-send-request#updateRequest" data-tabs-scroll="true">
  One of:
  tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes" tabindex="0"> number-1 number tabs#change click->alternative#change " data-tabs-target="tab" href="#operation-nodes-info-200-body-application-json-nodes-string-2-string" role="tab" aria-controls="operation-nodes-info-200-body-application-json-nodes-string-2-string" tabindex="0"> string-2 string
  
  transport object
  
  details#setActive"> Hide transport attributes Show transport attributes object
  
  bound_address array[string] Required
  
  publish_address string Required
  
  profiles object Required
  
  details#setActive"> Hide profiles attribute Show profiles attribute object
  
  * string Additional properties
  
  transport_address string Required
  
  transport_version number Required
  
  version string Required
  
  modules array[object]
  
  details#setActive"> Hide modules attributes Show modules attributes object
  
  classname string Required
  
  description string Required
  
  elasticsearch_version string Required
  
  extended_plugins array[string] Required
  
  has_native_controller boolean Required
  
  java_version string Required
  
  name string Required
  
  version string Required
  
  licensed boolean Required
  
  ingest object
  
  details#setActive"> Hide ingest attribute Show ingest attribute object
  
  processors array[object] Required
  
  aggregations object
  
  details#setActive"> Hide aggregations attribute Show aggregations attribute object
  
  * object Additional properties
  
  details#setActive"> Hide * attribute Show * attribute object
  
  types array[string] Required
  
  remote_cluster_server object
  
  details#setActive"> Hide remote_cluster_server attributes Show remote_cluster_server attributes object
  
  bound_address array[string] Required
  
  publish_address string Required

GET /_nodes/{node_id}/{metric}

GET _nodes/_all/jvm

resp = client.nodes.info(
    node_id="_all",
    metric="jvm",
)

const response = await client.nodes.info({
  node_id: "_all",
  metric: "jvm",
});

response = client.nodes.info(
  node_id: "_all",
  metric: "jvm"
)

$resp = $client->nodes()->info([
    "node_id" => "_all",
    "metric" => "jvm",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_nodes/_all/jvm"

client.nodes().info(i -> i
    .metric("jvm")
    .nodeId("_all")
);

Response examples (200)

An abbreviated response when requesting cluster nodes information.

{
    "_nodes": {},
    "cluster_name": "elasticsearch",
    "nodes": {
      "USpTGYaBSIKbgSUJR2Z9lg": {
        "name": "node-0",
        "transport_address": "192.168.17:9300",
        "host": "node-0.elastic.co",
        "ip": "192.168.17",
        "version": "{version}",
        "transport_version": 100000298,
        "index_version": 100000074,
        "component_versions": {
          "ml_config_version": 100000162,
          "transform_config_version": 100000096
        },
        "build_flavor": "default",
        "build_type": "{build_type}",
        "build_hash": "587409e",
        "roles": [
          "master",
          "data",
          "ingest"
        ],
        "attributes": {},
        "plugins": [
          {
            "name": "analysis-icu",
            "version": "{version}",
            "description": "The ICU Analysis plugin integrates Lucene ICU
  module into elasticsearch, adding ICU relates analysis components.",
            "classname":
  "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
            "has_native_controller": false
          }
        ],
        "modules": [
          {
            "name": "lang-painless",
            "version": "{version}",
            "description": "An easy, safe and fast scripting language for
  Elasticsearch",
            "classname": "org.elasticsearch.painless.PainlessPlugin",
            "has_native_controller": false
          }
        ]
      }
    }
}

Get node information Generally available; Added in 1.3.0

Path parameters

Query parameters

Responses

reason string | null

max_content_length number | string

using_compressed_ordinary_object_pointers boolean | string

total_indexing_buffer_in_bytes number | string