Get node information | Elasticsearch API documentation

Get node informationAdded in 1.3.0

GET /_nodes

Api key auth Basic auth Bearer auth

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

Query parameters

flat_settingsboolean
If true, returns settings in flat format.
timeoutstring
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodesobject
  Hide _nodes attributes Show _nodes attributes object
  failuresarray[object]
  Hide failures attributes Show failures attributes object
  typestring Required
  The type of error
  reasonstring
  A human-readable explanation of the error, in English.
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  root_causearray[object]
  suppressedarray[object]
  totalnumber Required
  Total number of nodes selected by the request.
  successfulnumber Required
  Number of nodes that responded successfully to the request.
  failednumber 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_namestring Required
- nodesobject Required
  Hide nodes attribute Show nodes attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  attributesobject Required
  Hide attributes attribute Show attributes attribute object
  *string Additional properties
  build_flavorstring Required
  build_hashstring Required
  Short hash of the last git commit in this release.
  build_typestring Required
  hoststring Required
  httpobject
  Hide http attributes Show http attributes object
  bound_addressarray[string] Required
  max_content_lengthnumber | string
  One of:
  ByteSizenumber ByteSizestring
  max_content_length_in_bytesnumber Required
  publish_addressstring Required
  ipstring Required
  jvmobject
  Hide jvm attributes Show jvm attributes object
  gc_collectorsarray[string] Required
  memobject Required
  Hide mem attributes Show mem attributes object
  direct_max
  direct_max_in_bytesnumber Required
  heap_init
  heap_init_in_bytesnumber Required
  heap_max
  heap_max_in_bytesnumber Required
  non_heap_init
  non_heap_init_in_bytesnumber Required
  non_heap_max
  non_heap_max_in_bytesnumber Required
  memory_poolsarray[string] Required
  pidnumber Required
  Time unit for milliseconds
  versionstring Required
  vm_namestring Required
  vm_vendorstring Required
  vm_versionstring Required
  using_bundled_jdkboolean Required
  using_compressed_ordinary_object_pointersboolean | string
  One of:
  boolean-1boolean string-2string
  input_argumentsarray[string] Required
  namestring Required
  networkobject
  Hide network attributes Show network attributes object
  primary_interfaceobject Required
  Hide primary_interface attributes Show primary_interface attributes object
  addressstring Required
  mac_addressstring Required
  namestring Required
  refresh_intervalnumber Required
  osobject
  Hide os attributes Show os attributes object
  archstring Required
  Name of the JVM architecture (ex: amd64, x86)
  available_processorsnumber Required
  Number of processors available to the Java virtual machine
  allocated_processorsnumber
  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.
  namestring Required
  pretty_namestring Required
  Time unit for milliseconds
  versionstring Required
  cpuobject
  Hide cpu attributes Show cpu attributes object
  cache_sizestring Required
  cache_size_in_bytesnumber Required
  cores_per_socketnumber Required
  mhznumber Required
  modelstring Required
  total_coresnumber Required
  total_socketsnumber Required
  vendorstring Required
  memobject
  Hide mem attributes Show mem attributes object
  totalstring Required
  total_in_bytesnumber Required
  swapobject
  Hide swap attributes Show swap attributes object
  totalstring Required
  total_in_bytesnumber Required
  pluginsarray[object]
  Hide plugins attributes Show plugins attributes object
  classnamestring Required
  descriptionstring Required
  elasticsearch_versionstring Required
  extended_pluginsarray[string] Required
  has_native_controllerboolean Required
  java_versionstring Required
  namestring Required
  versionstring Required
  licensedboolean Required
  processobject
  Hide process attributes Show process attributes object
  idnumber Required
  Process identifier (PID)
  mlockallboolean Required
  Indicates if the process address space has been successfully locked in memory
  Time unit for milliseconds
  rolesarray[string] Required
  @doc_id node-roles
  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.
  settingsobject
  Hide settings attributes Show settings attributes object
  clusterobject Required
  Hide cluster attributes Show cluster attributes object
  namestring Required
  routingobject
  electionobject Required
  initial_master_nodesarray[string]
  deprecation_indexingobject
  nodeobject Required
  Hide node attributes Show node attributes object
  namestring Required
  attrobject Required
  max_local_storage_nodesstring
  pathobject
  Hide path attributes Show path attributes object
  logsstring
  homestring
  repoarray[string]
  data
  repositoriesobject
  Hide repositories attribute Show repositories attribute object
  urlobject Required
  discoveryobject
  Hide discovery attributes Show discovery attributes object
  seed_hostsarray[string]
  typestring
  seed_providersarray[string]
  actionobject
  Hide action attribute Show action attribute object
  destructive_requires_namestring Required
  clientobject
  Hide client attribute Show client attribute object
  typestring Required
  httpobject Required
  Hide http attributes Show http attributes object
  typeobject Required
  type.defaultstring
  compression
  port
  bootstrapobject
  Hide bootstrap attribute Show bootstrap attribute object
  memory_lockstring Required
  transportobject Required
  Hide transport attributes Show transport attributes object
  typeobject Required
  type.defaultstring
  featuresobject
  networkobject
  Hide network attribute Show network attribute object
  host
  xpackobject
  Hide xpack attributes Show xpack attributes object
  licenseobject
  securityobject Required
  notificationobject
  mlobject
  scriptobject
  Hide script attributes Show script attributes object
  allowed_typesstring Required
  disable_max_compilations_ratestring
  searchobject
  Hide search attribute Show search attribute object
  remoteobject Required
  ingestobject
  Hide ingest attributes Show ingest attributes object
  attachmentobject
  appendobject
  csvobject
  convertobject
  dateobject
  date_index_nameobject
  dot_expanderobject
  enrichobject
  failobject
  foreachobject
  jsonobject
  user_agentobject
  kvobject
  geoipobject
  grokobject
  gsubobject
  joinobject
  lowercaseobject
  removeobject
  renameobject
  scriptobject
  setobject
  sortobject
  splitobject
  trimobject
  uppercaseobject
  urldecodeobject
  bytesobject
  dissectobject
  set_security_userobject
  pipelineobject
  dropobject
  circleobject
  inferenceobject
  thread_poolobject
  Hide thread_pool attribute Show thread_pool attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  corenumber
  keep_alivestring
  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.
  maxnumber
  queue_sizenumber Required
  sizenumber
  typestring Required
  total_indexing_buffernumber
  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_bytesnumber | string
  One of:
  ByteSizenumber ByteSizestring
  transportobject
  Hide transport attributes Show transport attributes object
  bound_addressarray[string] Required
  publish_addressstring Required
  profilesobject Required
  Hide profiles attribute Show profiles attribute object
  *string Additional properties
  transport_addressstring Required
  versionstring Required
  modulesarray[object]
  Hide modules attributes Show modules attributes object
  classnamestring Required
  descriptionstring Required
  elasticsearch_versionstring Required
  extended_pluginsarray[string] Required
  has_native_controllerboolean Required
  java_versionstring Required
  namestring Required
  versionstring Required
  licensedboolean Required
  ingestobject
  Hide ingest attribute Show ingest attribute object
  processorsarray[object] Required
  aggregationsobject
  Hide aggregations attribute Show aggregations attribute object
  *object Additional properties
  Hide * attribute Show * attribute object
  typesarray[string] Required

GET /_nodes

curl \
 --request GET 'http://api.example.com/_nodes' \
 --header "Authorization: $API_KEY"

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 informationAdded in 1.3.0

Query parameters

Responses

max_content_lengthnumber | string

using_compressed_ordinary_object_pointersboolean | string

total_indexing_buffer_in_bytesnumber | string