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.

  Values are -1 or 0.

Responses

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

  • roles array[string] Required
  • deciders object Required

    Decider settings.

    External documentation
    Hide deciders attribute Show deciders attribute object

    • * object Additional properties

Path parameters

• name string Required

  The name of the analytics collection to be deleted

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 component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Query parameters

• h string | array[string]

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

• s string | array[string]

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

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

  Values are -1 or 0.

Responses

• 200 application/json
  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

Responses

• 200 application/json

Query parameters

• h string | array[string]

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

• s string | array[string]

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

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

  Values are -1 or 0.

Responses

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

  • node string

    The node name.

  • id string

    The unique node identifier.

  • pid string

    The process identifier.

  • host string

    The host name.

  • ip string

    The IP address.

  • port string

    The bound transport port.

  • attr string

    The attribute name.

  • value string

    The attribute value.

Query parameters

• bytes string

  The unit used to display byte values.

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

• full_id boolean | string

  If true, return the full node ID. If false, return the shortened node ID.

• include_unloaded_segments boolean

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

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • build (or b): The Elasticsearch build hash. For example: 5c03844.
  • completion.size (or cs, completionSize): The size of completion. For example: 0b.
  • cpu: The percentage of recent system CPU used.
  • disk.avail (or d, disk, diskAvail): The available disk space. For example: 198.4gb.
  • disk.total (or dt, diskTotal): The total disk space. For example: 458.3gb.
  • disk.used (or du, diskUsed): The used disk space. For example: 259.8gb.
  • disk.used_percent (or dup, diskUsedPercent): The percentage of disk space used.
  • fielddata.evictions (or fe, fielddataEvictions): The number of fielddata cache evictions.
  • fielddata.memory_size (or fm, fielddataMemory): The fielddata cache memory used. For example: 0b.
  • file_desc.current (or fdc, fileDescriptorCurrent): The number of file descriptors used.
  • file_desc.max (or fdm, fileDescriptorMax): The maximum number of file descriptors.
  • file_desc.percent (or fdp, fileDescriptorPercent): The percentage of file descriptors used.
  • flush.total (or ft, flushTotal): The number of flushes.
  • flush.total_time (or ftt, flushTotalTime): The amount of time spent in flush.
  • get.current (or gc, getCurrent): The number of current get operations.
  • get.exists_time (or geti, getExistsTime): The time spent in successful get operations. For example: 14ms.
  • get.exists_total (or geto, getExistsTotal): The number of successful get operations.
  • get.missing_time (or gmti, getMissingTime): The time spent in failed get operations. For example: 0s.
  • get.missing_total (or gmto, getMissingTotal): The number of failed get operations.
  • get.time (or gti, getTime): The amount of time spent in get operations. For example: 14ms.
  • get.total (or gto, getTotal): The number of get operations.
  • heap.current (or hc, heapCurrent): The used heap size. For example: 311.2mb.
  • heap.max (or hm, heapMax): The total heap size. For example: 4gb.
  • heap.percent (or hp, heapPercent): The used percentage of total allocated Elasticsearch JVM heap. This value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.
  • http_address (or http): The bound HTTP address.
  • id (or nodeId): The identifier for the node.
  • indexing.delete_current (or idc, indexingDeleteCurrent): The number of current deletion operations.
  • indexing.delete_time (or idti, indexingDeleteTime): The time spent in deletion operations. For example: 2ms.
  • indexing.delete_total (or idto, indexingDeleteTotal): The number of deletion operations.
  • indexing.index_current (or iic, indexingIndexCurrent): The number of current indexing operations.
  • indexing.index_failed (or iif, indexingIndexFailed): The number of failed indexing operations.
  • indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): The number of indexing operations that failed due to version conflict.
  • indexing.index_time (or iiti, indexingIndexTime): The time spent in indexing operations. For example: 134ms.
  • indexing.index_total (or iito, indexingIndexTotal): The number of indexing operations.
  • ip (or i): The IP address.
  • jdk (or j): The Java version. For example: 1.8.0.
  • load_1m (or l): The most recent load average. For example: 0.22.
  • load_5m (or l): The load average for the last five minutes. For example: 0.78.
  • load_15m (or l): The load average for the last fifteen minutes. For example: 1.24.
  • mappings.total_count (or mtc, mappingsTotalCount): The number of mappings, including runtime and object fields.
  • mappings.total_estimated_overhead_in_bytes (or mteo, mappingsTotalEstimatedOverheadInBytes): The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
  • master (or m): Indicates whether the node is the elected master node. Returned values include * (elected master) and - (not elected master).
  • merges.current (or mc, mergesCurrent): The number of current merge operations.
  • merges.current_docs (or mcd, mergesCurrentDocs): The number of current merging documents.
  • merges.current_size (or mcs, mergesCurrentSize): The size of current merges. For example: 0b.
  • merges.total (or mt, mergesTotal): The number of completed merge operations.
  • merges.total_docs (or mtd, mergesTotalDocs): The number of merged documents.
  • merges.total_size (or mts, mergesTotalSize): The total size of merges. For example: 0b.
  • merges.total_time (or mtt, mergesTotalTime): The time spent merging documents. For example: 0s.
  • name (or n): The node name.
  • node.role (or r, role, nodeRole): The roles of the node. Returned values include c (cold node), d (data node), f (frozen node), h (hot node), i (ingest node), l (machine learning node), m (master-eligible node), r (remote cluster client node), s (content node), t (transform node), v (voting-only node), w (warm node), and - (coordinating node only). For example, dim indicates a master-eligible data and ingest node.
  • pid (or p): The process identifier.
  • port (or po): The bound transport port number.
  • query_cache.memory_size (or qcm, queryCacheMemory): The used query cache memory. For example: 0b.
  • query_cache.evictions (or qce, queryCacheEvictions): The number of query cache evictions.
  • query_cache.hit_count (or qchc, queryCacheHitCount): The query cache hit count.
  • query_cache.miss_count (or qcmc, queryCacheMissCount): The query cache miss count.
  • ram.current (or rc, ramCurrent): The used total memory. For example: 513.4mb.
  • ram.max (or rm, ramMax): The total memory. For example: 2.9gb.
  • ram.percent (or rp, ramPercent): The used percentage of the total operating system memory. This reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.
  • refresh.total (or rto, refreshTotal): The number of refresh operations.
  • refresh.time (or rti, refreshTime): The time spent in refresh operations. For example: 91ms.
  • request_cache.memory_size (or rcm, requestCacheMemory): The used request cache memory. For example: 0b.
  • request_cache.evictions (or rce, requestCacheEvictions): The number of request cache evictions.
  • request_cache.hit_count (or rchc, requestCacheHitCount): The request cache hit count.
  • request_cache.miss_count (or rcmc, requestCacheMissCount): The request cache miss count.
  • script.compilations (or scrcc, scriptCompilations): The number of total script compilations.
  • script.cache_evictions (or scrce, scriptCacheEvictions): The number of total compiled scripts evicted from cache.
  • search.fetch_current (or sfc, searchFetchCurrent): The number of current fetch phase operations.
  • search.fetch_time (or sfti, searchFetchTime): The time spent in fetch phase. For example: 37ms.
  • search.fetch_total (or sfto, searchFetchTotal): The number of fetch operations.
  • search.open_contexts (or so, searchOpenContexts): The number of open search contexts.
  • search.query_current (or sqc, searchQueryCurrent): The number of current query phase operations.
  • search.query_time (or sqti, searchQueryTime): The time spent in query phase. For example: 43ms.
  • search.query_total (or sqto, searchQueryTotal): The number of query operations.
  • search.scroll_current (or scc, searchScrollCurrent): The number of open scroll contexts.
  • search.scroll_time (or scti, searchScrollTime): The amount of time scroll contexts were held open. For example: 2m.
  • search.scroll_total (or scto, searchScrollTotal): The number of completed scroll contexts.
  • segments.count (or sc, segmentsCount): The number of segments.
  • segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields. For example: 1.0kb.
  • segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): The memory used by the index writer. For example: 18mb.
  • segments.memory (or sm, segmentsMemory): The memory used by segments. For example: 1.4kb.
  • segments.version_map_memory (or svmm, segmentsVersionMapMemory): The memory used by the version map. For example: 1.0kb.
  • shard_stats.total_count (or sstc, shards, shardStatsTotalCount): The number of shards assigned.
  • suggest.current (or suc, suggestCurrent): The number of current suggest operations.
  • suggest.time (or suti, suggestTime): The time spent in suggest operations.
  • suggest.total (or suto, suggestTotal): The number of suggest operations.
  • uptime (or u): The amount of node uptime. For example: 17.3m.
  • version (or v): The Elasticsearch version. For example: 9.0.0.
• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• master_timeout string

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

  Values are -1 or 0.

• time string

  The unit used to display time values.

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

Responses

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

  • id string
  • pid string

    The process identifier.

  • ip string

    The IP address.

  • port string

    The bound transport port.

  • http_address string

    The bound HTTP address.

  • version string
  • flavor string

    The Elasticsearch distribution flavor.

  • type string

    The Elasticsearch distribution type.

  • build string

    The Elasticsearch build hash.

  • jdk string

    The Java version.

  • disk.total number | string

    One of:

    number-1 number string-2 string

  • disk.used number | string

    One of:

    number-1 number string-2 string

  • disk.avail number | string

    One of:

    number-1 number string-2 string

  • disk.used_percent string | number

    One of:

    string-1 string number-2 number
  • heap.current string

    The used heap.

  • heap.percent string | number

    One of:

    string-1 string number-2 number
  • heap.max string

    The maximum configured heap.

  • ram.current string

    The used machine memory.

  • ram.percent string | number

    One of:

    string-1 string number-2 number
  • ram.max string

    The total machine memory.

  • file_desc.current string

    The used file descriptors.

  • file_desc.percent string | number

    One of:

    string-1 string number-2 number
  • file_desc.max string

    The maximum number of file descriptors.

  • cpu string

    The recent system CPU usage as a percentage.

  • load_1m string

    The load average for the most recent minute.

  • load_5m string

    The load average for the last five minutes.

  • load_15m string

    The load average for the last fifteen minutes.

  • uptime string

    The node uptime.

  • node.role string

    The roles of the node. Returned values include c(cold node), d(data node), f(frozen node), h(hot node), i(ingest node), l(machine learning node), m (master eligible node), r(remote cluster client node), s(content node), t(transform node), v(voting-only node), w(warm node),and -(coordinating node only).

  • master string

    Indicates whether the node is the elected master node. Returned values include *(elected master) and -(not elected master).

  • name string
  • completion.size string

    The size of completion.

  • fielddata.memory_size string

    The used fielddata cache.

  • fielddata.evictions string

    The fielddata evictions.

  • query_cache.memory_size string

    The used query cache.

  • query_cache.evictions string

    The query cache evictions.

  • query_cache.hit_count string

    The query cache hit counts.

  • query_cache.miss_count string

    The query cache miss counts.

  • request_cache.memory_size string

    The used request cache.

  • request_cache.evictions string

    The request cache evictions.

  • request_cache.hit_count string

    The request cache hit counts.

  • request_cache.miss_count string

    The request cache miss counts.

  • flush.total string

    The number of flushes.

  • flush.total_time string

    The time spent in flush.

  • get.current string

    The number of current get ops.

  • get.time string

    The time spent in get.

  • get.total string

    The number of get ops.

  • get.exists_time string

    The time spent in successful gets.

  • get.exists_total string

    The number of successful get operations.

  • get.missing_time string

    The time spent in failed gets.

  • get.missing_total string

    The number of failed gets.

  • indexing.delete_current string

    The number of current deletions.

  • indexing.delete_time string

    The time spent in deletions.

  • indexing.delete_total string

    The number of delete operations.

  • indexing.index_current string

    The number of current indexing operations.

  • indexing.index_time string

    The time spent in indexing.

  • indexing.index_total string

    The number of indexing operations.

  • indexing.index_failed string

    The number of failed indexing operations.

  • merges.current string

    The number of current merges.

  • merges.current_docs string

    The number of current merging docs.

  • merges.current_size string

    The size of current merges.

  • merges.total string

    The number of completed merge operations.

  • merges.total_docs string

    The docs merged.

  • merges.total_size string

    The size merged.

  • merges.total_time string

    The time spent in merges.

  • refresh.total string

    The total refreshes.

  • refresh.time string

    The time spent in refreshes.

  • refresh.external_total string

    The total external refreshes.

  • refresh.external_time string

    The time spent in external refreshes.

  • refresh.listeners string

    The number of pending refresh listeners.

  • script.compilations string

    The total script compilations.

  • script.cache_evictions string

    The total compiled scripts evicted from the cache.

  • script.compilation_limit_triggered string

    The script cache compilation limit triggered.

  • search.fetch_current string

    The current fetch phase operations.

  • search.fetch_time string

    The time spent in fetch phase.

  • search.fetch_total string

    The total fetch operations.

  • search.open_contexts string

    The open search contexts.

  • search.query_current string

    The current query phase operations.

  • search.query_time string

    The time spent in query phase.

  • search.query_total string

    The total query phase operations.

  • search.scroll_current string

    The open scroll contexts.

  • search.scroll_time string

    The time scroll contexts held open.

  • search.scroll_total string

    The completed scroll contexts.

  • segments.count string

    The number of segments.

  • segments.memory string

    The memory used by segments.

  • segments.index_writer_memory string

    The memory used by the index writer.

  • segments.version_map_memory string

    The memory used by the version map.

  • segments.fixed_bitset_memory string

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

  • suggest.current string

    The number of current suggest operations.

  • suggest.time string

    The time spend in suggest.

  • suggest.total string

    The number of suggest operations.

  • bulk.total_operations string

    The number of bulk shard operations.

  • bulk.total_time string

    The time spend in shard bulk.

  • bulk.total_size_in_bytes string

    The total size in bytes of shard bulk.

  • bulk.avg_time string

    The average time spend in shard bulk.

  • bulk.avg_size_in_bytes string

    The average size in bytes of shard bulk.

Query parameters

• h string | array[string]

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

• s string | array[string]

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

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

  Values are -1 or 0.

Responses

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

  • id string

    The unique repository identifier.

  • type string

    The repository type.

Path parameters

• index string | array[string] Required

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

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • index (or i, idx): The name of the index.
  • shard (or s, sh): The name of the shard.
  • prirep (or p, pr, primaryOrReplica): The shard type. Returned values are 'primary' or 'replica'.
  • ip: IP address of the segment’s shard, such as '127.0.1.1'.
  • segment: The name of the segment, such as '_0'. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.
  • generation: Generation number, such as '0'. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.
  • docs.count: The number of documents as reported by Lucene. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.
  • docs.deleted: The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.
  • size: The disk space used by the segment, such as '50kb'.
  • size.memory: The bytes of segment data stored in memory for efficient search, such as '1264'. A value of '-1' indicates Elasticsearch was unable to compute this number.
  • committed: If 'true', the segments is synced to disk. Segments that are synced can survive a hard reboot. If 'false', the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.
  • searchable: If 'true', the segment is searchable. If 'false', the segment has most likely been written to disk but needs a refresh to be searchable.
  • version: The version of Lucene used to write the segment.
  • compound: If 'true', the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.
  • id: The ID of the node, such as 'k0zy'.

  Values are index, i, idx, shard, s, sh, prirep, p, pr, primaryOrReplica, ip, segment, generation, docs.count, docs.deleted, size, size.memory, committed, searchable, version, compound, or id.

• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

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

  Values are -1 or 0.

Responses

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

  • index string
  • shard string

    The shard name.

  • prirep string

    The shard type: primary or replica.

  • ip string

    The IP address of the node where it lives.

  • id string
  • segment string

    The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.

  • generation string

    The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.

  • docs.count string

    The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.

  • docs.deleted string

    The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.

  • size number | string

    One of:

    number-1 number string-2 string

  • size.memory number | string

    One of:

    number-1 number string-2 string
  • committed string

    If true, the segment is synced to disk. Segments that are synced can survive a hard reboot. If false, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.

  • searchable string

    If true, the segment is searchable. If false, the segment has most likely been written to disk but needs a refresh to be searchable.

  • version string
  • compound string

    If true, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.

Path parameters

• name string Required

  The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

Query parameters

• h string | array[string]

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

• s string | array[string]

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

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

  Values are -1 or 0.

Responses

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

  • name string
  • index_patterns string

    The template index patterns.

  • order string

    The template application order or priority number.

  • version string | null

    The template version.

    One of:

    VersionString string string-2 string | null
  • composed_of string

    The component templates that comprise the index template.

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• 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

• allow_no_indices boolean

  Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

• expand_wildcards string | array[string]

  Whether to expand wildcard expression to concrete indices that are open, closed or both.

  Supported values include:

  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.

  Values are all, open, closed, hidden, or none.

• flat_settings boolean

  Return settings in flat format (default: false)

• ignore_unavailable boolean

  Whether specified concrete indices should be ignored when unavailable (missing or closed)

• local boolean

  Return local information, do not retrieve the state from master node (default: false)

• master_timeout string Deprecated

  Timeout for waiting for new cluster state in case it is blocked

  Values are -1 or 0.

• wait_for_metadata_version number

  Wait for the metadata version to be equal or greater than the specified metadata version

• wait_for_timeout string

  The maximum time to wait for wait_for_metadata_version before timing out

  Values are -1 or 0.

Responses

• 200 application/json

Responses

• 200 application/json

Path parameters

• node_id string | array[string] Required

  Comma-separated list of node IDs or names used to limit returned information.

• max_archive_version number Required

  Specifies the maximum archive_version to be cleared from the archive.

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • nodes object Required

    Contains repositories metering information for the nodes selected by the request.

    Hide nodes attribute Show nodes attribute object

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

      • repository_name string Required
      • repository_type string Required

        Repository type.

      • repository_location object Required
        Hide repository_location attributes Show repository_location attributes object

        • base_path string Required
        • container string

          Container name (Azure)

        • bucket string

          Bucket name (GCP, S3)

      • repository_ephemeral_id string Required

      • Time unit for milliseconds

      • Time unit for milliseconds

      • archived boolean Required

        A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations.

      • cluster_version number
      • request_counts object Required
        Hide request_counts attributes Show request_counts attributes object

        • GetBlobProperties number

          Number of Get Blob Properties requests (Azure)

        • GetBlob number

          Number of Get Blob requests (Azure)

        • ListBlobs number

          Number of List Blobs requests (Azure)

        • PutBlob number

          Number of Put Blob requests (Azure)

        • PutBlock number

          Number of Put Block (Azure)

        • PutBlockList number

          Number of Put Block List requests

        • GetObject number

          Number of get object requests (GCP, S3)

        • ListObjects number

          Number of list objects requests (GCP, S3)

        • InsertObject number

          Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation. (GCP)

        • PutObject number

          Number of PutObject requests (S3)

        • PutMultipartObject number

          Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)

Path parameters

• node_id string | array[string] Required

  Comma-separated list of node IDs or names used to limit returned information.

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • nodes object Required

    Contains repositories metering information for the nodes selected by the request.

    Hide nodes attribute Show nodes attribute object

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

      • repository_name string Required
      • repository_type string Required

        Repository type.

      • repository_location object Required
        Hide repository_location attributes Show repository_location attributes object

        • base_path string Required
        • container string

          Container name (Azure)

        • bucket string

          Bucket name (GCP, S3)

      • repository_ephemeral_id string Required

      • Time unit for milliseconds

      • Time unit for milliseconds

      • archived boolean Required

        A flag that tells whether or not this object has been archived. When a repository is closed or updated the repository metering information is archived and kept for a certain period of time. This allows retrieving the repository metering information of previous repository instantiations.

      • cluster_version number
      • request_counts object Required
        Hide request_counts attributes Show request_counts attributes object

        • GetBlobProperties number

          Number of Get Blob Properties requests (Azure)

        • GetBlob number

          Number of Get Blob requests (Azure)

        • ListBlobs number

          Number of List Blobs requests (Azure)

        • PutBlob number

          Number of Put Blob requests (Azure)

        • PutBlock number

          Number of Put Block (Azure)

        • PutBlockList number

          Number of Put Block List requests

        • GetObject number

          Number of get object requests (GCP, S3)

        • ListObjects number

          Number of list objects requests (GCP, S3)

        • InsertObject number

          Number of insert object requests, including simple, multipart and resumable uploads. Resumable uploads can perform multiple http requests to insert a single object but they are considered as a single request since they are billed as an individual operation. (GCP)

        • PutObject number

          Number of PutObject requests (S3)

        • PutMultipartObject number

          Number of Multipart requests, including CreateMultipartUpload, UploadPart and CompleteMultipartUpload requests (S3)

Path parameters

• node_id string | array[string] Required

  The names of particular nodes in the cluster to target.

Query parameters

• timeout string

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

  Values are -1 or 0.

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • nodes object Required
    Hide nodes attribute Show nodes attribute object

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

      • name string Required
      • reload_exception object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide reload_exception attributes Show reload_exception attributes object

        • type string Required

          The type of error

        • reason string | null

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

          One of:

          string-1 string string-2 string | null
        • stack_trace string

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

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressed array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

Path parameters

• node_id string | array[string] Required

  Comma-separated list of node IDs or names used to limit returned information.

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• index_metric string | array[string] Required

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

Query parameters

• completion_fields string | array[string]

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

• fielddata_fields string | array[string]

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

• fields string | array[string]

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

• groups boolean

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

• include_segment_file_sizes boolean

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

• level string

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

  Values are cluster, indices, or shards.

• timeout string

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

  Values are -1 or 0.

• types array[string]

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

• include_unloaded_segments boolean

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

Responses

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

  • _nodes object

    Contains statistics about the number of nodes selected by the request.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string | null

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

        One of:

        string-1 string string-2 string | null
      • stack_trace string

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

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string
  • nodes object Required
    Hide nodes attribute Show nodes attribute object

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

      • adaptive_selection object

        Statistics about adaptive replica selection.

        Hide adaptive_selection attribute Show adaptive_selection attribute object

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

          • avg_queue_size number

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

          • avg_response_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • avg_response_time_ns number

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

          • avg_service_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • avg_service_time_ns number

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

          • outgoing_searches number

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

          • rank string

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

      • breakers object

        Statistics about the field data circuit breaker.

        Hide breakers attribute Show breakers attribute object

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

          • estimated_size string

            Estimated memory used for the operation.

          • estimated_size_in_bytes number

            Estimated memory used, in bytes, for the operation.

          • limit_size string

            Memory limit for the circuit breaker.

          • limit_size_in_bytes number

            Memory limit, in bytes, for the circuit breaker.

          • overhead number

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

          • tripped number

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

      • fs object
        Hide fs attributes Show fs attributes object

        • data array[object]

          List of all file stores.
        • timestamp number

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

        • total object
          Hide total attributes Show total attributes object

          • available string

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

          • available_in_bytes number

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

          • free string

            Total unallocated disk space in all file stores.

          • free_in_bytes number

            Total number of unallocated bytes in all file stores.

          • total string

            Total size of all file stores.

          • total_in_bytes number

            Total size of all file stores in bytes.

        • io_stats object
          Hide io_stats attributes Show io_stats attributes object

          • devices array[object]

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

          • total object
      • host string
      • http object
        Hide http attributes Show http attributes object

        • current_open number

          Current number of open HTTP connections for the node.

        • total_opened number

          Total number of HTTP connections opened for the node.

        • clients array[object]

          Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.
        • routes object Required Generally available; Added in 8.12.0

          Detailed HTTP stats broken down by route

          Hide routes attribute Show routes attribute object

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

        • pipelines object

          Contains statistics about ingest pipelines for the node.

          Hide pipelines attribute Show pipelines attribute object

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

          • count number Required

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

          • current number Required

            Total number of documents currently being ingested.

          • failed number Required

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

      • ip string | array[string]

        IP address and port for the node.

        One of:

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

        • buffer_pools object

          Contains statistics about JVM buffer pools for the node.

          Hide buffer_pools attribute Show buffer_pools attribute object

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

          • current_loaded_count number

            Number of classes currently loaded by JVM.

          • total_loaded_count number

            Total number of classes loaded since the JVM started.

          • total_unloaded_count number

            Total number of classes unloaded since the JVM started.

        • gc object
          Hide gc attribute Show gc attribute object

          • collectors object

            Contains statistics about JVM garbage collectors for the node.

        • mem object
          Hide mem attributes Show mem attributes object

          • heap_used_in_bytes number

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

          • heap_used_percent number

            Percentage of memory currently in use by the heap.

          • heap_committed_in_bytes number

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

          • heap_max_in_bytes number

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

          • heap_max
          • non_heap_used_in_bytes number

            Non-heap memory used, in bytes.

          • non_heap_committed_in_bytes number

            Amount of non-heap memory available, in bytes.

          • pools object

            Contains statistics about heap memory usage for the node.

        • threads object
          Hide threads attributes Show threads attributes object

          • count number

            Number of active threads in use by JVM.

          • peak_count number

            Highest number of threads used by JVM.

        • timestamp number

          Last time JVM statistics were refreshed.

        • uptime string

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

        • uptime_in_millis number

          JVM uptime in milliseconds.

      • name string
      • os object
        Hide os attributes Show os attributes object

        • cpu object
          Hide cpu attributes Show cpu attributes object

          • percent number
          • sys string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • total string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • user string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

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

          • adjusted_total_in_bytes number

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

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

            Total amount of physical memory in bytes.

          • free_in_bytes number

            Amount of free physical memory in bytes.

          • used_in_bytes number

            Amount of used physical memory in bytes.

        • cgroup object
          Hide cgroup attributes Show cgroup attributes object

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

        • cpu object
          Hide cpu attributes Show cpu attributes object

          • percent number
          • sys string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • total string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • user string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

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

          • adjusted_total_in_bytes number

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

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

            Total amount of physical memory in bytes.

          • free_in_bytes number

            Amount of free physical memory in bytes.

          • used_in_bytes number

            Amount of used physical memory in bytes.

        • open_file_descriptors number

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

        • max_file_descriptors number

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

        • timestamp number

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

      • roles array[string]

        Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.

      • script object
        Hide script attributes Show script attributes object

        • cache_evictions number

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

        • compilations number

          Total number of inline script compilations performed by the node.

        • compilations_history object

          Contains this recent history of script compilations.

          Hide compilations_history attribute Show compilations_history attribute object

          • * number Additional properties
        • compilation_limit_triggered number

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

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

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

        Hide thread_pool attribute Show thread_pool attribute object

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

          • active number

            Number of active threads in the thread pool.

          • completed number

            Number of tasks completed by the thread pool executor.

          • largest number

            Highest number of active threads in the thread pool.

          • queue number

            Number of tasks in queue for the thread pool.

          • rejected number

            Number of tasks rejected by the thread pool executor.

          • threads number

            Number of threads in the thread pool.

      • timestamp number
      • transport object
        Hide transport attributes Show transport attributes object

        • inbound_handling_time_histogram array[object]

          The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
        • outbound_handling_time_histogram array[object]

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

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

        • rx_size string

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

        • rx_size_in_bytes number

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

        • server_open number

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

        • tx_count number

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

        • tx_size string

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

        • tx_size_in_bytes number

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

        • total_outbound_connections number

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

      • transport_address string
      • attributes object

        Contains a list of attributes for the node.

        Hide attributes attribute Show attributes attribute object

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

        • cluster_state_queue object
          Hide cluster_state_queue attributes Show cluster_state_queue attributes object

          • total number

            Total number of cluster states in queue.

          • pending number

            Number of pending cluster states in queue.

          • committed number

            Number of committed cluster states in queue.

        • published_cluster_states object
          Hide published_cluster_states attributes Show published_cluster_states attributes object

          • full_states number

            Number of published cluster states.

          • incompatible_diffs number

            Number of incompatible differences between published cluster states.

          • compatible_diffs number

            Number of compatible differences between published cluster states.

        • cluster_state_update object

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

          Hide cluster_state_update attribute Show cluster_state_update attribute object

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

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

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

        • memory object
          Hide memory attributes Show memory attributes object

          • limit
          • limit_in_bytes number

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

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

        • commit object
          Hide commit attributes Show commit attributes object

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

          • size_in_bytes number Required

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

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

          • count number Required

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

          • deleted number

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

          • total_size_in_bytes number Required

            Returns the total size in bytes of all documents in this stats. This value may be more reliable than store_stats.size_in_bytes in estimating the index size.

          • total_size
        • fielddata object
          Hide fielddata attributes Show fielddata attributes object

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

          • periodic number Required
          • total number Required
          • total_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • get object
          Hide get attributes Show get attributes object

          • current number Required
          • exists_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • exists_total number Required
          • missing_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • missing_total number Required
          • time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

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

          • index_current number Required
          • delete_current number Required
          • delete_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • delete_total number Required
          • is_throttled boolean Required
          • noop_update_total number Required
          • throttle_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • index_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

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

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

          • current number Required
          • current_docs number Required
          • current_size string
          • current_size_in_bytes number Required
          • total number Required
          • total_auto_throttle string
          • total_auto_throttle_in_bytes number Required
          • total_docs number Required
          • total_size string
          • total_size_in_bytes number Required
          • total_stopped_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • total_throttled_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • total_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • shard_path object
          Hide shard_path attributes Show shard_path attributes object

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

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

          • current_as_source number Required
          • current_as_target number Required
          • throttle_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • refresh object
          Hide refresh attributes Show refresh attributes object

          • external_total number Required
          • listeners number Required
          • total number Required
          • total_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • request_cache object
          Hide request_cache attributes Show request_cache attributes object

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

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

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

            Values are UNASSIGNED, INITIALIZING, STARTED, or RELOCATING.

        • search object
          Hide search attributes Show search attributes object

          • fetch_current number Required
          • fetch_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • fetch_total number Required
          • open_contexts number
          • query_current number Required
          • query_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • query_total number Required
          • scroll_current number Required
          • scroll_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • scroll_total number Required
          • suggest_current number Required
          • suggest_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

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

          • count number Required

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

          • doc_values_memory
          • doc_values_memory_in_bytes number Required

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

          • file_sizes object Required

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

          • fixed_bit_set
          • fixed_bit_set_memory_in_bytes number Required

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

          • index_writer_memory
          • index_writer_memory_in_bytes number Required

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

          • max_unsafe_auto_id_timestamp number Required

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

          • memory
          • memory_in_bytes number Required

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

          • norms_memory
          • norms_memory_in_bytes number Required

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

          • points_memory
          • points_memory_in_bytes number Required

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

          • stored_fields_memory_in_bytes number Required

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

          • stored_fields_memory
          • terms_memory_in_bytes number Required

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

          • terms_memory
          • term_vectors_memory
          • term_vectors_memory_in_bytes number Required

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

          • version_map_memory
          • version_map_memory_in_bytes number Required

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

        • seq_no object
          Hide seq_no attributes Show seq_no attributes object

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

          • size
          • size_in_bytes number Required

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

          • reserved
          • reserved_in_bytes number Required

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

          • total_data_set_size
          • total_data_set_size_in_bytes number

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

        • translog object
          Hide translog attributes Show translog attributes object

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

          • current number Required
          • total number Required
          • total_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • bulk object
          Hide bulk attributes Show bulk attributes object

          • total_operations number Required
          • total_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • total_size
          • total_size_in_bytes number Required
          • avg_time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • avg_size
          • avg_size_in_bytes number Required
        • shards object Generally available; Added in 7.15.0
          Hide shards attribute Show shards attribute object

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

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

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

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

          • status string

            Values are open or close.