Query parameters

• active_only boolean

  If true, the response only includes ongoing shard recoveries.

• bytes string

  The unit used to display byte values.

  Values are b, kb, mb, gb, tb, or pb.

• detailed boolean

  If true, the response includes detailed information about shard recoveries.

• index string | array[string]

  Comma-separated list or wildcard expression of index names to limit the returned information

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• time string

  Unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

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

  • index string
  • shard string

    The shard name.

  • start_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • start_time_millis number

    Time unit for milliseconds

  • stop_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • stop_time_millis number

    Time unit for milliseconds

  • time 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.

  • type string

    The recovery type.

  • stage string

    The recovery stage.

  • source_host string

    The source host.

  • source_node string

    The source node name.

  • target_host string

    The target host.

  • target_node string

    The target node name.

  • repository string

    The repository name.

  • snapshot string

    The snapshot name.

  • files string

    The number of files to recover.

  • files_recovered string

    The files recovered.

  • files_percent string | number

    One of:

    Percentage string Percentage number
  • files_total string

    The total number of files.

  • bytes string

    The number of bytes to recover.

  • bytes_recovered string

    The bytes recovered.

  • bytes_percent string | number

    One of:

    Percentage string Percentage number
  • bytes_total string

    The total number of bytes.

  • translog_ops string

    The number of translog operations to recover.

  • translog_ops_recovered string

    The translog operations recovered.

  • translog_ops_percent string | number

    One of:

    Percentage string Percentage number

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.

Responses

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

  • _nodes object
    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]
      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in English.

      • stack_trace string

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

      • caused_by object
      • 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 Required
  • nodes object Required
    Hide nodes attribute Show nodes attribute object

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

      • attributes object Required
        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
      • host string Required
      • http object
        Hide http attributes Show http attributes object

        • bound_address array[string] Required

        • max_content_length number | string

          One of:

          ByteSize number ByteSize string
        • max_content_length_in_bytes number Required
        • publish_address string Required
      • ip string Required
      • jvm object
        Hide jvm attributes Show jvm attributes object

        • gc_collectors array[string] Required
        • mem object Required
          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

          One of:

          boolean-1 boolean string-2 string
        • input_arguments array[string] Required
      • name string Required
      • network object
        Hide network attributes Show network attributes object

        • primary_interface object Required
          Hide primary_interface attributes Show primary_interface attributes object

          • address string Required
          • mac_address string Required
          • name string Required
        • refresh_interval number Required
      • os object
        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
          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
          Hide mem attributes Show mem attributes object

          • total string Required
          • total_in_bytes number Required
        • swap object
          Hide swap attributes Show swap attributes object

          • total string Required
          • total_in_bytes number Required
      • plugins array[object]
        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
        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
        • @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.

      • settings object
        Hide settings attributes Show settings attributes object

        • cluster object Required
          Hide cluster attributes Show cluster attributes object

          • name string Required
          • routing object
          • election object Required
          • initial_master_nodes array[string]
          • deprecation_indexing object
        • node object Required
          Hide node attributes Show node attributes object

          • name string Required
          • attr object Required
          • max_local_storage_nodes string
        • path object
          Hide path attributes Show path attributes object

          • logs string
          • home string
          • repo array[string]
          • data
        • repositories object
          Hide repositories attribute Show repositories attribute object

          • url object Required
        • discovery object
          Hide discovery attributes Show discovery attributes object

          • seed_hosts array[string]
          • type string
          • seed_providers array[string]
        • action object
          Hide action attribute Show action attribute object

          • destructive_requires_name string Required
        • client object
          Hide client attribute Show client attribute object

          • type string Required
        • http object Required
          Hide http attributes Show http attributes object

          • type object Required
          • type.default string
          • compression
          • port
        • bootstrap object
          Hide bootstrap attribute Show bootstrap attribute object

          • memory_lock string Required
        • transport object Required
          Hide transport attributes Show transport attributes object

          • type object Required
          • type.default string
          • features object
        • network object
          Hide network attribute Show network attribute object

          • host
        • xpack object
          Hide xpack attributes Show xpack attributes object

          • license object
          • security object Required
          • notification object
          • ml object
        • script object
          Hide script attributes Show script attributes object

          • allowed_types string Required
          • disable_max_compilations_rate string
        • search object
          Hide search attribute Show search attribute object

          • remote object Required
        • ingest object
          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
        Hide thread_pool attribute Show thread_pool attribute object

        • * object Additional properties
          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

        One of:

        ByteSize number ByteSize string
      • transport object
        Hide transport attributes Show transport attributes object

        • bound_address array[string] Required
        • publish_address string Required
        • profiles object Required
          Hide profiles attribute Show profiles attribute object

          • * string Additional properties
      • transport_address string Required
      • version string Required
      • modules array[object]
        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
        Hide ingest attribute Show ingest attribute object

        • processors array[object] Required
      • aggregations object
        Hide aggregations attribute Show aggregations attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • types array[string] Required

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• 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.

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 cluster, index, or shard level.

  Values are cluster, 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.

• 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
    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]
      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in English.

      • stack_trace string

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

      • caused_by object
      • 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 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.

          • avg_response_time_ns number

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

          • avg_service_time 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.

          • 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
        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.

        • total object
          Hide total attributes Show total attributes object

          • available string

            Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise.

          • available_in_bytes number

            Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free_in_bytes. This is the actual amount of free disk space the Elasticsearch node can utilise.

          • free string

            Total unallocated disk space in all file stores.

          • free_in_bytes number

            Total number of unallocated bytes in all file stores.

          • total string

            Total size of all file stores.

          • total_in_bytes number

            Total size of all file stores in bytes.

        • io_stats object
          Hide io_stats attributes Show io_stats attributes object

          • devices array[object]

            Array of disk metrics for each device that is backing an Elasticsearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.

          • total object
      • host string
      • http object
        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 Added in 8.12.0

          Detailed HTTP stats broken down by route

          Hide routes attribute Show routes attribute object

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

        • pipelines object

          Contains statistics about ingest pipelines for the node.

          Hide pipelines attribute Show pipelines attribute object

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

          • count number Required

            Total number of documents ingested during the lifetime of this node.

          • current number Required

            Total number of documents currently being ingested.

          • failed number Required

            Total number of failed ingest operations during the lifetime of this node.

      • ip string | array[string]

        IP address and port for the node.

        One of:

        Ip string array-2 array[string]
      • jvm object
        Hide jvm attributes Show jvm attributes object

        • buffer_pools object

          Contains statistics about JVM buffer pools for the node.

          Hide buffer_pools attribute Show buffer_pools attribute object

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

          • current_loaded_count number

            Number of classes currently loaded by JVM.

          • total_loaded_count number

            Total number of classes loaded since the JVM started.

          • total_unloaded_count number

            Total number of classes unloaded since the JVM started.

        • gc object
          Hide gc attribute Show gc attribute object

          • collectors object

            Contains statistics about JVM garbage collectors for the node.

        • mem object
          Hide mem attributes Show mem attributes object

          • heap_used_in_bytes number

            Memory, in bytes, currently in use by the heap.

          • heap_used_percent number

            Percentage of memory currently in use by the heap.

          • heap_committed_in_bytes number

            Amount of memory, in bytes, available for use by the heap.

          • heap_max_in_bytes number

            Maximum amount of memory, in bytes, available for use by the heap.

          • non_heap_used_in_bytes number

            Non-heap memory used, in bytes.

          • non_heap_committed_in_bytes number

            Amount of non-heap memory available, in bytes.

          • pools object

            Contains statistics about heap memory usage for the node.

        • threads object
          Hide threads attributes Show threads attributes object

          • count number

            Number of active threads in use by JVM.

          • peak_count number

            Highest number of threads used by JVM.

        • 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
      • os object
        Hide os attributes Show os attributes object

        • cpu object
          Hide cpu attributes Show cpu attributes object

          • percent number
          • sys 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.

          • total 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.

          • user 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.

          • load_average object
        • swap object
          Hide swap attributes Show swap attributes object

          • adjusted_total_in_bytes number

            If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.

          • resident string
          • resident_in_bytes number
          • share string
          • share_in_bytes number
          • total_virtual string
          • total_virtual_in_bytes number
          • total_in_bytes number

            Total amount of physical memory in bytes.

          • free_in_bytes number

            Amount of free physical memory in bytes.

          • used_in_bytes number

            Amount of used physical memory in bytes.

        • cgroup object
          Hide cgroup attributes Show cgroup attributes object

          • cpuacct object
          • cpu object
          • memory object
        • timestamp number
      • process object
        Hide process attributes Show process attributes object

        • cpu object
          Hide cpu attributes Show cpu attributes object

          • percent number
          • sys 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.

          • total 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.

          • user 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.

          • load_average object
        • mem object
          Hide mem attributes Show mem attributes object

          • adjusted_total_in_bytes number

            If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.

          • resident string
          • resident_in_bytes number
          • share string
          • share_in_bytes number
          • total_virtual string
          • total_virtual_in_bytes number
          • total_in_bytes number

            Total amount of physical memory in bytes.

          • free_in_bytes number

            Amount of free physical memory in bytes.

          • used_in_bytes number

            Amount of used physical memory in bytes.

        • 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]
        • @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.

      • script object
        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.

          Hide compilations_history attribute Show compilations_history attribute object

          • * number Additional properties
        • 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
        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
      • attributes object

        Contains a list of attributes for the node.

        Hide attributes attribute Show attributes attribute object

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

        • cluster_state_queue object
          Hide cluster_state_queue attributes Show cluster_state_queue attributes object

          • total number

            Total number of cluster states in queue.

          • pending number

            Number of pending cluster states in queue.

          • committed number

            Number of committed cluster states in queue.

        • published_cluster_states object
          Hide published_cluster_states attributes Show published_cluster_states attributes object

          • full_states number

            Number of published cluster states.

          • incompatible_diffs number

            Number of incompatible differences between published cluster states.

          • compatible_diffs number

            Number of compatible differences between published cluster states.

        • 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.

          Hide cluster_state_update attribute Show cluster_state_update attribute object

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

          • full_states object
          • diffs object
        • cluster_applier_stats object
          Hide cluster_applier_stats attribute Show cluster_applier_stats attribute object

          • recordings array[object]
      • indexing_pressure object
        Hide indexing_pressure attribute Show indexing_pressure attribute object

        • memory object
          Hide memory attributes Show memory attributes object

          • limit
          • limit_in_bytes number

            Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.

          • current object
          • total object
      • indices object
        Hide indices attributes Show indices attributes object

        • commit object
          Hide commit attributes Show commit attributes object

          • generation number Required
          • id string Required
          • num_docs number Required
          • user_data object Required
        • completion object
          Hide completion attributes Show completion attributes object

          • size_in_bytes number Required

            Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.

          • size
          • fields object
        • docs object
          Hide docs attributes Show docs attributes object

          • count number Required

            Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.

          • deleted number

            Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.

        • fielddata object
          Hide fielddata attributes Show fielddata attributes object

          • evictions number
          • memory_size
          • memory_size_in_bytes number Required
          • fields object
        • flush object
          Hide flush attributes Show flush attributes object

          • periodic number Required
          • total number Required
          • total_time 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.

        • get object
          Hide get attributes Show get attributes object

          • current number Required
          • exists_time 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.

          • exists_total number Required
          • missing_time 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.

          • missing_total number Required
          • time 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.

          • total number Required
        • indexing object
          Hide indexing attributes Show indexing attributes object

          • index_current number Required
          • delete_current number Required
          • delete_time 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.

          • delete_total number Required
          • is_throttled boolean Required
          • noop_update_total number Required
          • throttle_time 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.

          • index_time 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.

          • index_total number Required
          • index_failed number Required
          • types object
          • write_load number
          • recent_write_load number
          • peak_write_load number
        • mappings object
          Hide mappings attributes Show mappings attributes object

          • total_count number Required
          • total_estimated_overhead
          • total_estimated_overhead_in_bytes number Required
        • merges object
          Hide merges attributes Show merges attributes object

          • current number Required
          • current_docs number Required
          • current_size string
          • current_size_in_bytes number Required
          • total number Required
          • total_auto_throttle string
          • total_auto_throttle_in_bytes number Required
          • total_docs number Required
          • total_size string
          • total_size_in_bytes number Required
          • total_stopped_time 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.

          • total_throttled_time 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.

          • total_time 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.

        • shard_path object
          Hide shard_path attributes Show shard_path attributes object

          • data_path string Required
          • is_custom_data_path boolean Required
          • state_path string Required
        • query_cache object
          Hide query_cache attributes Show query_cache attributes object

          • cache_count number Required
          • cache_size number Required
          • evictions number Required
          • hit_count number Required
          • memory_size_in_bytes number Required
          • miss_count number Required
          • total_count number Required
        • recovery object
          Hide recovery attributes Show recovery attributes object

          • current_as_source number Required
          • current_as_target number Required
          • throttle_time 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.

        • refresh object
          Hide refresh attributes Show refresh attributes object

          • external_total number Required
          • listeners number Required
          • total number Required
          • total_time 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.

        • request_cache object
          Hide request_cache attributes Show request_cache attributes object

          • evictions number Required
          • hit_count number Required
          • memory_size string
          • memory_size_in_bytes number Required
          • miss_count number Required
        • retention_leases object
          Hide retention_leases attributes Show retention_leases attributes object

          • primary_term number Required
          • version number Required
          • leases array[object] Required
        • routing object
          Hide routing attributes Show routing attributes object

          • node string Required
          • primary boolean Required
          • relocating_node
          • state string Required

            Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.

        • search object
          Hide search attributes Show search attributes object

          • fetch_current number Required
          • fetch_time 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.

          • fetch_total number Required
          • open_contexts number
          • query_current number Required
          • query_time 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.

          • query_total number Required
          • scroll_current number Required
          • scroll_time 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.

          • scroll_total number Required
          • suggest_current number Required
          • suggest_time 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.

          • suggest_total number Required
          • groups object
        • segments object
          Hide segments attributes Show segments attributes object

          • count number Required

            Total number of segments across all shards assigned to selected nodes.

          • doc_values_memory
          • doc_values_memory_in_bytes number Required

            Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.

          • file_sizes object Required

            This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.

          • fixed_bit_set
          • fixed_bit_set_memory_in_bytes number Required

            Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.

          • index_writer_memory
          • index_writer_max_memory_in_bytes number
          • index_writer_memory_in_bytes number Required

            Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.

          • max_unsafe_auto_id_timestamp number Required

            Unix timestamp, in milliseconds, of the most recently retried indexing request.

          • memory
          • memory_in_bytes number Required

            Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.

          • norms_memory
          • norms_memory_in_bytes number Required

            Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.

          • points_memory
          • points_memory_in_bytes number Required

            Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.

          • stored_memory
          • stored_fields_memory_in_bytes number Required

            Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.

          • terms_memory_in_bytes number Required

            Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.

          • terms_memory
          • term_vectory_memory
          • term_vectors_memory_in_bytes number Required

            Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.

          • version_map_memory
          • version_map_memory_in_bytes number Required

            Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.

        • seq_no object
          Hide seq_no attributes Show seq_no attributes object

          • global_checkpoint number Required
          • local_checkpoint number Required
          • max_seq_no number Required
        • store object
          Hide store attributes Show store attributes object

          • size
          • size_in_bytes number Required

            Total size, in bytes, of all shards assigned to selected nodes.

          • reserved
          • reserved_in_bytes number Required

            A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

          • total_data_set_size
          • total_data_set_size_in_bytes number

            Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

        • translog object
          Hide translog attributes Show translog attributes object

          • earliest_last_modified_age number Required
          • operations number Required
          • size string
          • size_in_bytes number Required
          • uncommitted_operations number Required
          • uncommitted_size string
          • uncommitted_size_in_bytes number Required
        • warmer object
          Hide warmer attributes Show warmer attributes object

          • current number Required
          • total number Required
          • total_time 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.

        • bulk object
          Hide bulk attributes Show bulk attributes object

          • total_operations number Required
          • total_time 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.

          • total_size
          • total_size_in_bytes number Required
          • avg_time 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.

          • avg_size
          • avg_size_in_bytes number Required
        • shards object
          Hide shards attribute Show shards attribute object

          • * object Additional properties
        • shard_stats object
          Hide shard_stats attribute Show shard_stats attribute object

          • total_count number Required
        • indices object Additional properties
          Hide indices attributes Show indices attributes object

          • primaries object
          • shards object
          • total object
          • uuid string
          • health string

            Values are green, GREEN, yellow, YELLOW, red, or RED.

          • status string

            Values are open or close.