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]

  Limit the information returned to the specified metrics

  Supported values include: _all, _none, indices, os, process, jvm, thread_pool, fs, transport, http, breaker, script, discovery, ingest, adaptive_selection, script_cache, indexing_pressure, repositories, allocations

  Values are _all, _none, indices, os, process, jvm, thread_pool, fs, transport, http, breaker, script, discovery, ingest, adaptive_selection, script_cache, indexing_pressure, repositories, or allocations.

• index_metric string | array[string] Required

  Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.

  Supported values include: _all, store, indexing, get, search, merge, flush, refresh, query_cache, fielddata, docs, warmer, completion, segments, translog, request_cache, recovery, bulk, shard_stats, mappings, dense_vector, sparse_vector

  Values are _all, store, indexing, get, search, merge, flush, refresh, query_cache, fielddata, docs, warmer, completion, segments, translog, request_cache, recovery, bulk, shard_stats, mappings, dense_vector, or sparse_vector.

Query parameters

• completion_fields string | array[string]

  Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

• fielddata_fields string | array[string]

  Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

• fields string | array[string]

  Comma-separated list or wildcard expressions of fields to include in the statistics.

• groups boolean

  Comma-separated list of search groups to include in the search statistics.

• include_segment_file_sizes boolean

  If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

• level string

  Indicates whether statistics are aggregated at the node, indices, or shards level.

  Values are node, indices, or shards.

• timeout string

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

  External documentation
• types array[string]

  A comma-separated list of document types for the indexing index metric.

• include_unloaded_segments boolean

  If true, the response includes information from segments that are not loaded into memory.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • _nodes object

    Contains statistics about the number of nodes selected by the request’s node filters.

    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.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason
      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by
      • root_cause array[object]
      • suppressed array[object]
    • 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
  • nodes object Required
    Hide nodes attribute Show nodes attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • adaptive_selection object

        Statistics about adaptive replica selection.

        Hide adaptive_selection attribute Show adaptive_selection attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • avg_queue_size number

            The exponentially weighted moving average queue size of search requests on the keyed node.

          • avg_response_time_ns number

            The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.

          • avg_service_time_ns number

            The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.

          • outgoing_searches number

            The number of outstanding search requests to the keyed node from the node these stats are for.

          • rank string

            The rank of this node; used for shard selection when routing search requests.

      • breakers object

        Statistics about the field data circuit breaker.

        Hide breakers attribute Show breakers attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • estimated_size string

            Estimated memory used for the operation.

          • estimated_size_in_bytes number

            Estimated memory used, in bytes, for the operation.

          • limit_size string

            Memory limit for the circuit breaker.

          • limit_size_in_bytes number

            Memory limit, in bytes, for the circuit breaker.

          • overhead number

            A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.

          • tripped number

            Total number of times the circuit breaker has been triggered and prevented an out of memory error.

      • fs object

        File system information, data path, free disk space, read/write stats.

        Hide fs attributes Show fs attributes object

        • data array[object]

          List of all file stores.

        • timestamp number

          Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.

      • host string

        Network host for the node, based on the network host setting.

      • http object

        HTTP connection information.

        Hide http attributes Show http attributes object

        • current_open number

          Current number of open HTTP connections for the node.

        • total_opened number

          Total number of HTTP connections opened for the node.

        • clients array[object]

          Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.

        • routes object Required Generally available; Added in 8.12.0

          Detailed HTTP stats broken down by route

      • ingest object

        Statistics about ingest preprocessing.

        Hide ingest attribute Show ingest attribute object

        • pipelines object

          Contains statistics about ingest pipelines for the node.

      • ip string | array[string]

        IP address and port for the node.

        One of:

        Ip string array-2 array[string]
      • jvm object

        JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.

        Hide jvm attributes Show jvm attributes object

        • buffer_pools object

          Contains statistics about JVM buffer pools for the node.

        • timestamp number

          Last time JVM statistics were refreshed.

        • uptime string

          Human-readable JVM uptime. Only returned if the human query parameter is true.

        • uptime_in_millis number

          JVM uptime in milliseconds.

      • name string

        Human-readable identifier for the node. Based on the node name setting.

      • os object

        Operating system stats, load average, mem, swap.

        Hide os attribute Show os attribute object

        • timestamp number
      • process object

        Process statistics, memory consumption, cpu usage, open file descriptors.

        Hide process attributes Show process attributes object

        • open_file_descriptors number

          Number of opened file descriptors associated with the current or -1 if not supported.

        • max_file_descriptors number

          Maximum number of file descriptors allowed on the system, or -1 if not supported.

        • timestamp number

          Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch.

      • roles array[string]

        Roles assigned to the node.

        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.

      • script object

        Contains script statistics for the node.

        Hide script attributes Show script attributes object

        • cache_evictions number

          Total number of times the script cache has evicted old data.

        • compilations number

          Total number of inline script compilations performed by the node.

        • compilations_history object

          Contains this recent history of script compilations.

        • compilation_limit_triggered number

          Total number of times the script compilation circuit breaker has limited inline script compilations.

        • contexts array[object]
      • script_cache object
      • thread_pool object

        Statistics about each thread pool, including current size, queue and rejected tasks.

        Hide thread_pool attribute Show thread_pool attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • active number

            Number of active threads in the thread pool.

          • completed number

            Number of tasks completed by the thread pool executor.

          • largest number

            Highest number of active threads in the thread pool.

          • queue number

            Number of tasks in queue for the thread pool.

          • rejected number

            Number of tasks rejected by the thread pool executor.

          • threads number

            Number of threads in the thread pool.

      • timestamp number
      • transport object

        Transport statistics about sent and received bytes in cluster communication.

        Hide transport attributes Show transport attributes object

        • inbound_handling_time_histogram array[object]

          The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.

        • outbound_handling_time_histogram array[object]

          The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.

        • rx_count number

          Total number of RX (receive) packets received by the node during internal cluster communication.

        • rx_size string

          Size of RX packets received by the node during internal cluster communication.

        • rx_size_in_bytes number

          Size, in bytes, of RX packets received by the node during internal cluster communication.

        • server_open number

          Current number of inbound TCP connections used for internal communication between nodes.

        • tx_count number

          Total number of TX (transmit) packets sent by the node during internal cluster communication.

        • tx_size string

          Size of TX packets sent by the node during internal cluster communication.

        • tx_size_in_bytes number

          Size, in bytes, of TX packets sent by the node during internal cluster communication.

        • total_outbound_connections number

          The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.

      • transport_address string

        Host and port for the transport layer, used for internal communication between nodes in a cluster.

      • attributes object

        Contains a list of attributes for the node.

        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
      • discovery object

        Contains node discovery statistics for the node.

        Hide discovery attribute Show discovery attribute object

        • cluster_state_update object

          Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in _time within this object is also represented as a raw number of milliseconds in a field whose name ends in _time_millis. The human-readable fields with a _time suffix are only returned if requested with the ?human=true query parameter.

      • indexing_pressure object

        Contains indexing pressure statistics for the node.

      • indices object

        Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.

        Hide indices attribute Show indices attribute object

        • shards object Generally available; Added in 7.15.0