Path parameters

• index string | array[string] Required

  A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Query parameters

• completion_fields string | array[string]

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

• expand_wildcards string | array[string]

  Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

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

• forbid_closed_indices boolean

  If true, statistics are not collected from closed indices.

• groups string | array[string]

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

• include_unloaded_segments boolean

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

• level string

  Indicates whether statistics are aggregated at the cluster, index, or shard level.

  Values are cluster, indices, or shards.

Responses

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

  • indices object
    Hide indices attribute Show indices attribute object

    • * object Additional properties

      Additional properties are allowed.

      Hide * attributes Show * attributes object

      • primaries object

        Additional properties are allowed.

        Hide primaries attributes Show primaries attributes object

        • completion object

          Additional properties are allowed.

          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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • fields object
            Hide fields attribute Show fields attribute object

            • * object Additional properties

              Additional properties are allowed.

        • docs object

          Additional properties are allowed.

          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

          Additional properties are allowed.

          Hide fielddata attributes Show fielddata attributes object

          • evictions number

          • memory_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_size_in_bytes number Required
          • fields object
            Hide fields attribute Show fields attribute object

            • * object Additional properties

              Additional properties are allowed.

        • flush object

          Additional properties are allowed.

          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.

          • total_time_in_millis number

            Time unit for milliseconds

        • get object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

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

          • time_in_millis number

            Time unit for milliseconds

          • total number Required
        • indexing object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

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

          • throttle_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • index_total number Required
          • index_failed number Required
          • types object
            Hide types attribute Show types attribute object

            • * object

              Additional properties are allowed.

          • write_load number
        • indices object Additional properties

          Additional properties are allowed.

        • merges object

          Additional properties are allowed.

          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_stopped_time_in_millis number

            Time unit for milliseconds

          • 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_throttled_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

        • query_cache object

          Additional properties are allowed.

          Hide query_cache attributes Show query_cache attributes object

          • cache_count number Required

            Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

          • cache_size number Required

            Total number of entries currently in the query cache across all shards assigned to selected nodes.

          • evictions number Required

            Total number of query cache evictions across all shards assigned to selected nodes.

          • hit_count number Required

            Total count of query cache hits across all shards assigned to selected nodes.

          • memory_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_size_in_bytes number Required

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

          • miss_count number Required

            Total count of query cache misses across all shards assigned to selected nodes.

          • total_count number Required

            Total count of hits and misses in the query cache across all shards assigned to selected nodes.

        • recovery object

          Additional properties are allowed.

          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.

          • throttle_time_in_millis number

            Time unit for milliseconds

        • refresh object

          Additional properties are allowed.

          Hide refresh attributes Show refresh attributes object

          • external_total number Required
          • external_total_time_in_millis number

            Time unit for milliseconds

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

          • total_time_in_millis number

            Time unit for milliseconds

        • request_cache object

          Additional properties are allowed.

          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
        • search object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • suggest_total number Required
          • groups object
            Hide groups attribute Show groups attribute object

            • * object

              Additional properties are allowed.

        • segments object

          Additional properties are allowed.

          Hide segments attributes Show segments attributes object

          • count number Required

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

          • doc_values_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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.

            Hide file_sizes attribute Show file_sizes attribute object

            • * object Additional properties

              Additional properties are allowed.

          • fixed_bit_set number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_in_bytes number Required

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

          • norms_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • points_memory_in_bytes number Required

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

          • stored_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string

          • term_vectory_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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.

        • store object

          Additional properties are allowed.

          Hide store attributes Show store attributes object

          • size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • size_in_bytes number Required

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

          • reserved number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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

          Additional properties are allowed.

          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

          Additional properties are allowed.

          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.

          • total_time_in_millis number

            Time unit for milliseconds

        • bulk object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • total_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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_time_in_millis number

            Time unit for milliseconds

          • avg_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • avg_size_in_bytes number Required
        • shard_stats object

          Additional properties are allowed.

          Hide shard_stats attribute Show shard_stats attribute object

          • total_count number Required
      • shards object
        Hide shards attribute Show shards attribute object

        • * array[object] Additional properties
          Hide * attributes Show * attributes object

          • commit object

            Additional properties are allowed.

          • completion object

            Additional properties are allowed.

          • docs object

            Additional properties are allowed.

          • fielddata object

            Additional properties are allowed.

          • flush object

            Additional properties are allowed.

          • get object

            Additional properties are allowed.

          • indexing object

            Additional properties are allowed.

          • mappings object

            Additional properties are allowed.

          • merges object

            Additional properties are allowed.

          • shard_path object

            Additional properties are allowed.

          • query_cache object

            Additional properties are allowed.

          • recovery object

            Additional properties are allowed.

          • refresh object

            Additional properties are allowed.

          • request_cache object

            Additional properties are allowed.

          • retention_leases object

            Additional properties are allowed.

          • routing object

            Additional properties are allowed.

          • search object

            Additional properties are allowed.

          • segments object

            Additional properties are allowed.

          • seq_no object

            Additional properties are allowed.

          • store object

            Additional properties are allowed.

          • translog object

            Additional properties are allowed.

          • warmer object

            Additional properties are allowed.

          • bulk object

            Additional properties are allowed.

          • shards object
          • shard_stats object

            Additional properties are allowed.

          • indices object Additional properties

            Additional properties are allowed.

      • total object

        Additional properties are allowed.

        Hide total attributes Show total attributes object

        • completion object

          Additional properties are allowed.

          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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • fields object
            Hide fields attribute Show fields attribute object

            • * object Additional properties

              Additional properties are allowed.

        • docs object

          Additional properties are allowed.

          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

          Additional properties are allowed.

          Hide fielddata attributes Show fielddata attributes object

          • evictions number

          • memory_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_size_in_bytes number Required
          • fields object
            Hide fields attribute Show fields attribute object

            • * object Additional properties

              Additional properties are allowed.

        • flush object

          Additional properties are allowed.

          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.

          • total_time_in_millis number

            Time unit for milliseconds

        • get object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

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

          • time_in_millis number

            Time unit for milliseconds

          • total number Required
        • indexing object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

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

          • throttle_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • index_total number Required
          • index_failed number Required
          • types object
            Hide types attribute Show types attribute object

            • * object

              Additional properties are allowed.

          • write_load number
        • indices object Additional properties

          Additional properties are allowed.

        • merges object

          Additional properties are allowed.

          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_stopped_time_in_millis number

            Time unit for milliseconds

          • 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_throttled_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

        • query_cache object

          Additional properties are allowed.

          Hide query_cache attributes Show query_cache attributes object

          • cache_count number Required

            Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

          • cache_size number Required

            Total number of entries currently in the query cache across all shards assigned to selected nodes.

          • evictions number Required

            Total number of query cache evictions across all shards assigned to selected nodes.

          • hit_count number Required

            Total count of query cache hits across all shards assigned to selected nodes.

          • memory_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_size_in_bytes number Required

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

          • miss_count number Required

            Total count of query cache misses across all shards assigned to selected nodes.

          • total_count number Required

            Total count of hits and misses in the query cache across all shards assigned to selected nodes.

        • recovery object

          Additional properties are allowed.

          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.

          • throttle_time_in_millis number

            Time unit for milliseconds

        • refresh object

          Additional properties are allowed.

          Hide refresh attributes Show refresh attributes object

          • external_total number Required
          • external_total_time_in_millis number

            Time unit for milliseconds

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

          • total_time_in_millis number

            Time unit for milliseconds

        • request_cache object

          Additional properties are allowed.

          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
        • search object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • 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_time_in_millis number

            Time unit for milliseconds

          • suggest_total number Required
          • groups object
            Hide groups attribute Show groups attribute object

            • * object

              Additional properties are allowed.

        • segments object

          Additional properties are allowed.

          Hide segments attributes Show segments attributes object

          • count number Required

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

          • doc_values_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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.

            Hide file_sizes attribute Show file_sizes attribute object

            • * object Additional properties

              Additional properties are allowed.

          • fixed_bit_set number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • memory_in_bytes number Required

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

          • norms_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • points_memory_in_bytes number Required

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

          • stored_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string

          • term_vectory_memory number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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.

        • store object

          Additional properties are allowed.

          Hide store attributes Show store attributes object

          • size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • size_in_bytes number Required

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

          • reserved number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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 number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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

          Additional properties are allowed.

          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

          Additional properties are allowed.

          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.

          • total_time_in_millis number

            Time unit for milliseconds

        • bulk object

          Additional properties are allowed.

          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_time_in_millis number

            Time unit for milliseconds

          • total_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • 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_time_in_millis number

            Time unit for milliseconds

          • avg_size number | string

            One of:

            _types:ByteSize number _types:ByteSize string
          • avg_size_in_bytes number Required
        • shard_stats object

          Additional properties are allowed.

          Hide shard_stats attribute Show shard_stats attribute object

          • total_count number Required
      • uuid string
      • health string

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

      • status string

        Values are open or close.

  • _shards object Required

    Additional properties are allowed.

    Hide _shards attributes Show _shards attributes object

    • failed number Required
    • successful number Required
    • total number Required
    • failures array[object]
      Hide failures attributes Show failures attributes object

      • index string
      • node string
      • reason object Required

        Additional properties are allowed.

        Hide reason attributes Show reason 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

          Additional properties are allowed.

        • root_cause array[object]

          Additional properties are allowed.

        • suppressed array[object]

          Additional properties are allowed.

      • shard number Required
      • status string
    • skipped number
  • _all object Required Additional properties

    Additional properties are allowed.

    Hide _all attributes Show _all attributes object

    • primaries object

      Additional properties are allowed.

      Hide primaries attributes Show primaries attributes object

      • completion object

        Additional properties are allowed.

        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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • fields object
          Hide fields attribute Show fields attribute object

          • * object Additional properties

            Additional properties are allowed.

            Hide * attributes Show * attributes object

            • size
            • size_in_bytes number Required
      • docs object

        Additional properties are allowed.

        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

        Additional properties are allowed.

        Hide fielddata attributes Show fielddata attributes object

        • evictions number

        • memory_size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • memory_size_in_bytes number Required
        • fields object
          Hide fields attribute Show fields attribute object

          • * object Additional properties

            Additional properties are allowed.

            Hide * attributes Show * attributes object

            • memory_size
            • memory_size_in_bytes number Required
      • flush object

        Additional properties are allowed.

        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.

        • total_time_in_millis number

          Time unit for milliseconds

      • get object

        Additional properties are allowed.

        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_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

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

        • time_in_millis number

          Time unit for milliseconds

        • total number Required
      • indexing object

        Additional properties are allowed.

        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_time_in_millis number

          Time unit for milliseconds

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

        • throttle_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

        • index_total number Required
        • index_failed number Required
        • types object
          Hide types attribute Show types attribute object

          • * object

            Additional properties are allowed.

        • write_load number
      • indices object Additional properties

        Additional properties are allowed.

      • merges object

        Additional properties are allowed.

        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_stopped_time_in_millis number

          Time unit for milliseconds

        • 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_throttled_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

      • query_cache object

        Additional properties are allowed.

        Hide query_cache attributes Show query_cache attributes object

        • cache_count number Required

          Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

        • cache_size number Required

          Total number of entries currently in the query cache across all shards assigned to selected nodes.

        • evictions number Required

          Total number of query cache evictions across all shards assigned to selected nodes.

        • hit_count number Required

          Total count of query cache hits across all shards assigned to selected nodes.

        • memory_size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • memory_size_in_bytes number Required

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

        • miss_count number Required

          Total count of query cache misses across all shards assigned to selected nodes.

        • total_count number Required

          Total count of hits and misses in the query cache across all shards assigned to selected nodes.

      • recovery object

        Additional properties are allowed.

        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.

        • throttle_time_in_millis number

          Time unit for milliseconds

      • refresh object

        Additional properties are allowed.

        Hide refresh attributes Show refresh attributes object

        • external_total number Required
        • external_total_time_in_millis number

          Time unit for milliseconds

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

        • total_time_in_millis number

          Time unit for milliseconds

      • request_cache object

        Additional properties are allowed.

        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
      • search object

        Additional properties are allowed.

        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_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

        • 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_time_in_millis number

          Time unit for milliseconds

        • suggest_total number Required
        • groups object
          Hide groups attribute Show groups attribute object

          • * object

            Additional properties are allowed.

      • segments object

        Additional properties are allowed.

        Hide segments attributes Show segments attributes object

        • count number Required

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

        • doc_values_memory number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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.

          Hide file_sizes attribute Show file_sizes attribute object

          • * object Additional properties

            Additional properties are allowed.

            Hide * attributes Show * attributes object

            • description string Required
            • size_in_bytes number Required
            • min_size_in_bytes number
            • max_size_in_bytes number
            • average_size_in_bytes number
            • count number

        • fixed_bit_set number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • memory_in_bytes number Required

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

        • norms_memory number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • points_memory_in_bytes number Required

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

        • stored_memory number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string

        • term_vectory_memory number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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.

      • store object

        Additional properties are allowed.

        Hide store attributes Show store attributes object

        • size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • size_in_bytes number Required

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

        • reserved number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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 number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • 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

        Additional properties are allowed.

        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

        Additional properties are allowed.

        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.

        • total_time_in_millis number

          Time unit for milliseconds

      • bulk object

        Additional properties are allowed.

        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_time_in_millis number

          Time unit for milliseconds

        • total_size number | string

          One of:

          _types:ByteSize number _types:ByteSize string
        • total_size_in_bytes number Required