Authentication

Path parameters

• name string Required

  the name of the autoscaling policy

Query parameters

• master_timeout string

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

• 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 attribute Show response attribute object

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

Path parameters

• name string Required

  The name of the analytics collection to be created or updated.

Responses

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

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

  • name string Required

Path parameters

• node_id string | array[string] Required

  A comma-separated list of node identifiers or names used to limit the returned information.

Query parameters

• bytes string

  The unit used to display byte values.

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

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  Period to wait for a connection to the master node.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • shards string

    Number of primary and replica shards assigned to the node.

  • shards.undesired string | null

    Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used

    One of:

    string-1 string string-2 string | null

  • write_load.forecast number | string | null

    Sum of index write load forecasts

    One of:

    _spec_utils:Stringifieddouble number _spec_utils:Stringifieddouble string string-2 string | null

  • disk.indices.forecast number | string | null

    Sum of shard size forecasts

    One of:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.indices number | string | null

    Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.

    One of:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.used number | string | null

    Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.

    One of:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.avail number | string | null

    Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.

    One of:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.total number | string | null

    Total disk space for the node, including in-use and available space.

    One of:

    _types:ByteSize number _types:ByteSize string string-2 string | null

  • disk.percent string | number | null

    Total percentage of disk space in use. Calculated as disk.used / disk.total.

    One of:

    _types:Percentage string _types:Percentage number string-2 string | null

  • host string | null

    Network host for the node. Set using the network.host setting.

    One of:

    _types:Host string string-2 string | null

  • ip string | null

    IP address and port for the node.

    One of:

    _types:Ip string string-2 string | null
  • node string

    Name for the node. Set using the node.name setting.

  • node.role string | null

    Node roles

    One of:

    string-1 string string-2 string | null

Path parameters

• name string Required

  The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Query parameters

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  The period to wait for a connection to the master node.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • name string Required

  • version string | null Required

    One of:

    string-1 string string-2 string | null
  • alias_count string Required
  • mapping_count string Required
  • settings_count string Required
  • metadata_count string Required
  • included_in string Required

Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

• bytes string

  The unit used to display byte values.

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

• expand_wildcards string | array[string]

  The type of index that wildcard patterns can match.

• health string

  The health status used to limit returned indices. By default, the response includes indices of any health status.

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

• include_unloaded_segments boolean

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

• pri boolean

  If true, the response only includes information from primary shards.

• time string

  The unit used to display time values.

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

• master_timeout string

  Period to wait for a connection to the master node.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • health string

    current health status

  • status string

    open/close status

  • index string

    index name

  • uuid string

    index uuid

  • pri string

    number of primary shards

  • rep string

    number of replica shards

  • docs.count string | null

    available docs

    One of:

    string-1 string string-2 string | null

  • docs.deleted string | null

    deleted docs

    One of:

    string-1 string string-2 string | null
  • creation.date string

    index creation date (millisecond value)

  • creation.date.string string

    index creation date (as string)

  • store.size string | null

    store size of primaries & replicas

    One of:

    string-1 string string-2 string | null

  • pri.store.size string | null

    store size of primaries

    One of:

    string-1 string string-2 string | null

  • dataset.size string | null

    total size of dataset (including the cache for partially mounted indices)

    One of:

    string-1 string string-2 string | null
  • completion.size string

    size of completion

  • pri.completion.size string

    size of completion

  • fielddata.memory_size string

    used fielddata cache

  • pri.fielddata.memory_size string

    used fielddata cache

  • fielddata.evictions string

    fielddata evictions

  • pri.fielddata.evictions string

    fielddata evictions

  • query_cache.memory_size string

    used query cache

  • pri.query_cache.memory_size string

    used query cache

  • query_cache.evictions string

    query cache evictions

  • pri.query_cache.evictions string

    query cache evictions

  • request_cache.memory_size string

    used request cache

  • pri.request_cache.memory_size string

    used request cache

  • request_cache.evictions string

    request cache evictions

  • pri.request_cache.evictions string

    request cache evictions

  • request_cache.hit_count string

    request cache hit count

  • pri.request_cache.hit_count string

    request cache hit count

  • request_cache.miss_count string

    request cache miss count

  • pri.request_cache.miss_count string

    request cache miss count

  • flush.total string

    number of flushes

  • pri.flush.total string

    number of flushes

  • flush.total_time string

    time spent in flush

  • pri.flush.total_time string

    time spent in flush

  • get.current string

    number of current get ops

  • pri.get.current string

    number of current get ops

  • get.time string

    time spent in get

  • pri.get.time string

    time spent in get

  • get.total string

    number of get ops

  • pri.get.total string

    number of get ops

  • get.exists_time string

    time spent in successful gets

  • pri.get.exists_time string

    time spent in successful gets

  • get.exists_total string

    number of successful gets

  • pri.get.exists_total string

    number of successful gets

  • get.missing_time string

    time spent in failed gets

  • pri.get.missing_time string

    time spent in failed gets

  • get.missing_total string

    number of failed gets

  • pri.get.missing_total string

    number of failed gets

  • indexing.delete_current string

    number of current deletions

  • pri.indexing.delete_current string

    number of current deletions

  • indexing.delete_time string

    time spent in deletions

  • pri.indexing.delete_time string

    time spent in deletions

  • indexing.delete_total string

    number of delete ops

  • pri.indexing.delete_total string

    number of delete ops

  • indexing.index_current string

    number of current indexing ops

  • pri.indexing.index_current string

    number of current indexing ops

  • indexing.index_time string

    time spent in indexing

  • pri.indexing.index_time string

    time spent in indexing

  • indexing.index_total string

    number of indexing ops

  • pri.indexing.index_total string

    number of indexing ops

  • indexing.index_failed string

    number of failed indexing ops

  • pri.indexing.index_failed string

    number of failed indexing ops

  • merges.current string

    number of current merges

  • pri.merges.current string

    number of current merges

  • merges.current_docs string

    number of current merging docs

  • pri.merges.current_docs string

    number of current merging docs

  • merges.current_size string

    size of current merges

  • pri.merges.current_size string

    size of current merges

  • merges.total string

    number of completed merge ops

  • pri.merges.total string

    number of completed merge ops

  • merges.total_docs string

    docs merged

  • pri.merges.total_docs string

    docs merged

  • merges.total_size string

    size merged

  • pri.merges.total_size string

    size merged

  • merges.total_time string

    time spent in merges

  • pri.merges.total_time string

    time spent in merges

  • refresh.total string

    total refreshes

  • pri.refresh.total string

    total refreshes

  • refresh.time string

    time spent in refreshes

  • pri.refresh.time string

    time spent in refreshes

  • refresh.external_total string

    total external refreshes

  • pri.refresh.external_total string

    total external refreshes

  • refresh.external_time string

    time spent in external refreshes

  • pri.refresh.external_time string

    time spent in external refreshes

  • refresh.listeners string

    number of pending refresh listeners

  • pri.refresh.listeners string

    number of pending refresh listeners

  • search.fetch_current string

    current fetch phase ops

  • pri.search.fetch_current string

    current fetch phase ops

  • search.fetch_time string

    time spent in fetch phase

  • pri.search.fetch_time string

    time spent in fetch phase

  • search.fetch_total string

    total fetch ops

  • pri.search.fetch_total string

    total fetch ops

  • search.open_contexts string

    open search contexts

  • pri.search.open_contexts string

    open search contexts

  • search.query_current string

    current query phase ops

  • pri.search.query_current string

    current query phase ops

  • search.query_time string

    time spent in query phase

  • pri.search.query_time string

    time spent in query phase

  • search.query_total string

    total query phase ops

  • pri.search.query_total string

    total query phase ops

  • search.scroll_current string

    open scroll contexts

  • pri.search.scroll_current string

    open scroll contexts

  • search.scroll_time string

    time scroll contexts held open

  • pri.search.scroll_time string

    time scroll contexts held open

  • search.scroll_total string

    completed scroll contexts

  • pri.search.scroll_total string

    completed scroll contexts

  • segments.count string

    number of segments

  • pri.segments.count string

    number of segments

  • segments.memory string

    memory used by segments

  • pri.segments.memory string

    memory used by segments

  • segments.index_writer_memory string

    memory used by index writer

  • pri.segments.index_writer_memory string

    memory used by index writer

  • segments.version_map_memory string

    memory used by version map

  • pri.segments.version_map_memory string

    memory used by version map

  • segments.fixed_bitset_memory string

    memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields

  • pri.segments.fixed_bitset_memory string

    memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields

  • warmer.current string

    current warmer ops

  • pri.warmer.current string

    current warmer ops

  • warmer.total string

    total warmer ops

  • pri.warmer.total string

    total warmer ops

  • warmer.total_time string

    time spent in warmers

  • pri.warmer.total_time string

    time spent in warmers

  • suggest.current string

    number of current suggest ops

  • pri.suggest.current string

    number of current suggest ops

  • suggest.time string

    time spend in suggest

  • pri.suggest.time string

    time spend in suggest

  • suggest.total string

    number of suggest ops

  • pri.suggest.total string

    number of suggest ops

  • memory.total string

    total used memory

  • pri.memory.total string

    total user memory

  • search.throttled string

    indicates if the index is search throttled

  • bulk.total_operations string

    number of bulk shard ops

  • pri.bulk.total_operations string

    number of bulk shard ops

  • bulk.total_time string

    time spend in shard bulk

  • pri.bulk.total_time string

    time spend in shard bulk

  • bulk.total_size_in_bytes string

    total size in bytes of shard bulk

  • pri.bulk.total_size_in_bytes string

    total size in bytes of shard bulk

  • bulk.avg_time string

    average time spend in shard bulk

  • pri.bulk.avg_time string

    average time spend in shard bulk

  • bulk.avg_size_in_bytes string

    average size in bytes of shard bulk

  • pri.bulk.avg_size_in_bytes string

    average size in bytes of shard bulk

Query parameters

• actions array[string]

  The task action names, which are used to limit the response.

• detailed boolean

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

• nodes array[string]

  Unique node identifiers, which are used to limit the response.

• parent_task_id string

  The parent task identifier, which is used to limit the response.

• time string

  Unit used to display time values.

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

• timeout string

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

• wait_for_completion boolean

  If true, the request blocks until the task has completed.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string
  • action string

    The task action.

  • task_id string
  • parent_task_id string

    The parent task identifier.

  • type string

    The task type.

  • start_time string

    The start time in milliseconds.

  • timestamp string

    The start time in HH:MM:SS format.

  • running_time_ns string

    The running time in nanoseconds.

  • running_time string

    The running time.

  • node_id string
  • ip string

    The IP address for the node.

  • port string

    The bound transport port for the node.

  • node string

    The node name.

  • version string
  • x_opaque_id string

    The X-Opaque-ID header.

  • description string

    The task action description.

Query parameters

• include_remotes boolean

  Include remote cluster data into the response

• timeout string

  Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

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
  • cluster_uuid string Required
  • indices object Required
    Hide indices attributes Show indices attributes object

    • analysis object Required
      Hide analysis attributes Show analysis attributes object

      • analyzer_types array[object] Required

        Contains statistics about analyzer types used in selected nodes.

        Hide analyzer_types attributes Show analyzer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_analyzers array[object] Required

        Contains statistics about built-in analyzers used in selected nodes.

        Hide built_in_analyzers attributes Show built_in_analyzers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_char_filters array[object] Required

        Contains statistics about built-in character filters used in selected nodes.

        Hide built_in_char_filters attributes Show built_in_char_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_filters array[object] Required

        Contains statistics about built-in token filters used in selected nodes.

        Hide built_in_filters attributes Show built_in_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_tokenizers array[object] Required

        Contains statistics about built-in tokenizers used in selected nodes.

        Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • char_filter_types array[object] Required

        Contains statistics about character filter types used in selected nodes.

        Hide char_filter_types attributes Show char_filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • filter_types array[object] Required

        Contains statistics about token filter types used in selected nodes.

        Hide filter_types attributes Show filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • tokenizer_types array[object] Required

        Contains statistics about tokenizer types used in selected nodes.

        Hide tokenizer_types attributes Show tokenizer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

    • completion object Required
      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.

      • fields object
        Hide fields attribute Show fields attribute object

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

          • size_in_bytes number Required
    • count number Required

      Total number of indices with shards assigned to selected nodes.

    • docs object Required
      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 Required
      Hide fielddata attributes Show fielddata attributes object

      • evictions number
      • memory_size_in_bytes number Required
      • fields object
        Hide fields attribute Show fields attribute object

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

          • memory_size_in_bytes number Required
    • query_cache object Required
      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_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.

    • segments object Required
      Hide segments attributes Show segments attributes object

      • count number Required

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

      • 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
          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_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_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_in_bytes number Required

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

      • 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_in_bytes number Required

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

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

      • 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_in_bytes number Required

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

    • shards object Required
      Hide shards attributes Show shards attributes object

      • index object
        Hide index attributes Show index attributes object

        • primaries object Required
          Hide primaries attributes Show primaries attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • replication object Required
          Hide replication attributes Show replication attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • shards object Required
          Hide shards attributes Show shards attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

      • primaries number

        Number of primary shards assigned to selected nodes.

      • replication number

        Ratio of replica shards to primary shards across all selected nodes.

      • total number

        Total number of shards assigned to selected nodes.

    • store object Required
      Hide store attributes Show store attributes object

      • size_in_bytes number Required

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

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

    • mappings object Required
      Hide mappings attributes Show mappings attributes object

      • field_types array[object] Required

        Contains statistics about field data types used in selected nodes.

        Hide field_types attributes Show field_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • runtime_field_types array[object]

        Contains statistics about runtime field data types used in selected nodes.

        Hide runtime_field_types attributes Show runtime_field_types attributes object

        • chars_max number Required

          Maximum number of characters for a single runtime field script.

        • chars_total number Required

          Total number of characters for the scripts that define the current runtime field data type.

        • count number Required

          Number of runtime fields mapped to the field data type in selected nodes.

        • doc_max number Required

          Maximum number of accesses to doc_values for a single runtime field script

        • doc_total number Required

          Total number of accesses to doc_values for the scripts that define the current runtime field data type.

        • index_count number Required

          Number of indices containing a mapping of the runtime field data type in selected nodes.

        • lang array[string] Required

          Script languages used for the runtime fields scripts.

        • lines_max number Required

          Maximum number of lines for a single runtime field script.

        • lines_total number Required

          Total number of lines for the scripts that define the current runtime field data type.

        • name string Required
        • scriptless_count number Required

          Number of runtime fields that don’t declare a script.

        • shadowed_count number Required

          Number of runtime fields that shadow an indexed field.

        • source_max number Required

          Maximum number of accesses to _source for a single runtime field script.

        • source_total number Required

          Total number of accesses to _source for the scripts that define the current runtime field data type.

      • total_field_count number

        Total number of fields in all non-system indices.

      • total_deduplicated_field_count number

        Total number of fields in all non-system indices, accounting for mapping deduplication.

      • total_deduplicated_mapping_size_in_bytes number

        Total size of all mappings, in bytes, after deduplication and compression.

    • versions array[object]

      Contains statistics about analyzers and analyzer components used in selected nodes.

      Hide versions attributes Show versions attributes object

      • index_count number Required
      • primary_shard_count number Required
      • total_primary_bytes number Required
      • version string Required
  • nodes object Required
    Hide nodes attributes Show nodes attributes object

    • count object Required
      Hide count attributes Show count attributes object

      • coordinating_only number Required
      • data number Required
      • data_cold number Required
      • data_content number Required
      • data_frozen number
      • data_hot number Required
      • data_warm number Required
      • ingest number Required
      • master number Required
      • ml number Required
      • remote_cluster_client number Required
      • total number Required
      • transform number Required
      • voting_only number Required
    • discovery_types object Required

      Contains statistics about the discovery types used by selected nodes.

      Hide discovery_types attribute Show discovery_types attribute object

      • * number Additional properties
    • fs object Required
      Hide fs attributes Show fs attributes object

      • available_in_bytes number Required

        Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.

      • free_in_bytes number Required

        Total number of unallocated bytes in file stores across all selected nodes.

      • total_in_bytes number Required

        Total size, in bytes, of all file stores across all selected nodes.

    • indexing_pressure object Required
      Hide indexing_pressure attribute Show indexing_pressure attribute object

      • memory object Required
        Hide memory attributes Show memory attributes object

        • current object Required
          Hide current attributes Show current attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
        • limit_in_bytes number Required
        • total object Required
          Hide total attributes Show total attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
    • ingest object Required
      Hide ingest attributes Show ingest attributes object

      • number_of_pipelines number Required
      • processor_stats object Required
        Hide processor_stats attribute Show processor_stats attribute object

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

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

    • jvm object Required
      Hide jvm attributes Show jvm attributes object

      • Time unit for milliseconds

      • mem object Required
        Hide mem attributes Show mem attributes object

        • heap_max_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.

        • heap_used_in_bytes number Required

          Memory, in bytes, currently in use by the heap across all selected nodes.

      • threads number Required

        Number of active threads in use by JVM across all selected nodes.

      • versions array[object] Required

        Contains statistics about the JVM versions used by selected nodes.

        Hide versions attributes Show versions attributes object

        • bundled_jdk boolean Required

          Always true. All distributions come with a bundled Java Development Kit (JDK).

        • count number Required

          Total number of selected nodes using JVM.

        • using_bundled_jdk boolean Required

          If true, a bundled JDK is in use by JVM.

        • version string Required
        • vm_name string Required

          Name of the JVM.

        • vm_vendor string Required

          Vendor of the JVM.

        • vm_version string Required
    • network_types object Required
      Hide network_types attributes Show network_types attributes object

      • http_types object Required

        Contains statistics about the HTTP network types used by selected nodes.

        Hide http_types attribute Show http_types attribute object

        • * number Additional properties
      • transport_types object Required

        Contains statistics about the transport network types used by selected nodes.

        Hide transport_types attribute Show transport_types attribute object

        • * number Additional properties
    • os object Required
      Hide os attributes Show os attributes object

      • allocated_processors number Required

        Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.

      • architectures array[object]

        Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

        Hide architectures attributes Show architectures attributes object

        • arch string Required

          Name of an architecture used by one or more selected nodes.

        • count number Required

          Number of selected nodes using the architecture.

      • available_processors number Required

        Number of processors available to JVM across all selected nodes.

      • mem object Required
        Hide mem attributes Show mem attributes object

        • adjusted_total_in_bytes number

          Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.

        • free_in_bytes number Required

          Amount, in bytes, of free physical memory across all selected nodes.

        • free_percent number Required

          Percentage of free physical memory across all selected nodes.

        • total_in_bytes number Required

          Total amount, in bytes, of physical memory across all selected nodes.

        • used_in_bytes number Required

          Amount, in bytes, of physical memory in use across all selected nodes.

        • used_percent number Required

          Percentage of physical memory in use across all selected nodes.

      • names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide names attributes Show names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • name string Required
      • pretty_names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide pretty_names attributes Show pretty_names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • pretty_name string Required
    • packaging_types array[object] Required

      Contains statistics about Elasticsearch distributions installed on selected nodes.

      Hide packaging_types attributes Show packaging_types attributes object

      • count number Required

        Number of selected nodes using the distribution flavor and file type.

      • flavor string Required

        Type of Elasticsearch distribution. This is always default.

      • type string Required

        File type (such as tar or zip) used for the distribution package.

    • plugins array[object] Required

      Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

      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 Required
      Hide process attributes Show process attributes object

      • cpu object Required
        Hide cpu attribute Show cpu attribute object

        • percent number Required

          Percentage of CPU used across all selected nodes. Returns -1 if not supported.

      • open_file_descriptors object Required
        Hide open_file_descriptors attributes Show open_file_descriptors attributes object

        • avg number Required

          Average number of concurrently open file descriptors. Returns -1 if not supported.

        • max number Required

          Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.

        • min number Required

          Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.

    • versions array[string] Required

      Array of Elasticsearch versions used on selected nodes.

  • status string Required

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

  • timestamp number Required

    Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

Query parameters

• ignore_idle_threads boolean

  If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out.

• interval string

  The interval to do the second sampling of threads.

• snapshots number

  Number of samples of thread stacktrace.

• master_timeout string

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

• threads number

  Specifies the number of hot threads to provide information for.

• timeout string

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

• type string

  The type to sample.

  Values are cpu, wait, block, gpu, or mem.

• sort string

  The sort order for 'cpu' type (default: total)

  Values are cpu, wait, block, gpu, or mem.

Responses

• 200 application/json