Get cluster statistics | Elasticsearch API documentation

Query parameters

include_remotesboolean
Include remote cluster data into the response
timeoutstring
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.
Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- _nodesobject
  Contains statistics about the number of nodes selected by the request.
  Hide _nodes attributes Show _nodes attributes object
  failuresarray[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
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  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_causearray[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.
  suppressedarray[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.
  totalnumber Required
  Total number of nodes selected by the request.
  successfulnumber Required
  Number of nodes that responded successfully to the request.
  failednumber 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_namestring Required
- cluster_uuidstring Required
- indicesobject Required
  Hide indices attributes Show indices attributes object
  analysisobject Required
  Hide analysis attributes Show analysis attributes object
  analyzer_typesarray[object] Required
  Contains statistics about analyzer types used in selected nodes.
  Hide analyzer_types attributes Show analyzer_types attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  built_in_analyzersarray[object] Required
  Contains statistics about built-in analyzers used in selected nodes.
  Hide built_in_analyzers attributes Show built_in_analyzers attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  built_in_char_filtersarray[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
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  built_in_filtersarray[object] Required
  Contains statistics about built-in token filters used in selected nodes.
  Hide built_in_filters attributes Show built_in_filters attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  built_in_tokenizersarray[object] Required
  Contains statistics about built-in tokenizers used in selected nodes.
  Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  char_filter_typesarray[object] Required
  Contains statistics about character filter types used in selected nodes.
  Hide char_filter_types attributes Show char_filter_types attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  filter_typesarray[object] Required
  Contains statistics about token filter types used in selected nodes.
  Hide filter_types attributes Show filter_types attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  tokenizer_typesarray[object] Required
  Contains statistics about tokenizer types used in selected nodes.
  Hide tokenizer_types attributes Show tokenizer_types attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  completionobject Required
  Hide completion attributes Show completion attributes object
  size_in_bytesnumber Required
  Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  size
  size_in_bytesnumber Required
  countnumber Required
  Total number of indices with shards assigned to selected nodes.
  docsobject Required
  Hide docs attributes Show docs attributes object
  countnumber 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.
  deletednumber
  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.
  fielddataobject Required
  Hide fielddata attributes Show fielddata attributes object
  evictionsnumber
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  fieldsobject
  Hide fields attribute Show fields attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  memory_size
  memory_size_in_bytesnumber Required
  query_cacheobject Required
  Hide query_cache attributes Show query_cache attributes object
  cache_countnumber 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_sizenumber Required
  Total number of entries currently in the query cache across all shards assigned to selected nodes.
  evictionsnumber Required
  Total number of query cache evictions across all shards assigned to selected nodes.
  hit_countnumber Required
  Total count of query cache hits across all shards assigned to selected nodes.
  memory_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_size_in_bytesnumber Required
  Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
  miss_countnumber Required
  Total count of query cache misses across all shards assigned to selected nodes.
  total_countnumber Required
  Total count of hits and misses in the query cache across all shards assigned to selected nodes.
  segmentsobject Required
  Hide segments attributes Show segments attributes object
  countnumber Required
  Total number of segments across all shards assigned to selected nodes.
  doc_values_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  doc_values_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
  file_sizesobject 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
  descriptionstring Required
  size_in_bytesnumber Required
  min_size_in_bytesnumber
  max_size_in_bytesnumber
  average_size_in_bytesnumber
  countnumber
  fixed_bit_setnumber | string
  One of:
  ByteSizenumber ByteSizestring
  fixed_bit_set_memory_in_bytesnumber Required
  Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
  index_writer_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  index_writer_max_memory_in_bytesnumber
  index_writer_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
  max_unsafe_auto_id_timestampnumber Required
  Unix timestamp, in milliseconds, of the most recently retried indexing request.
  memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
  norms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  norms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
  points_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  points_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
  stored_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  stored_fields_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
  terms_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
  terms_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectory_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  term_vectors_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
  version_map_memorynumber | string
  One of:
  ByteSizenumber ByteSizestring
  version_map_memory_in_bytesnumber Required
  Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
  shardsobject Required
  Contains statistics about shards assigned to selected nodes.
  Hide shards attributes Show shards attributes object
  indexobject
  Hide index attributes Show index attributes object
  primariesobject Required
  Hide primaries attributes Show primaries attributes object
  avgnumber Required
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  maxnumber Required
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  minnumber Required
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  replicationobject Required
  Hide replication attributes Show replication attributes object
  avgnumber Required
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  maxnumber Required
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  minnumber Required
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  shardsobject Required
  Hide shards attributes Show shards attributes object
  avgnumber Required
  Mean number of shards in an index, counting only shards assigned to selected nodes.
  maxnumber Required
  Maximum number of shards in an index, counting only shards assigned to selected nodes.
  minnumber Required
  Minimum number of shards in an index, counting only shards assigned to selected nodes.
  primariesnumber
  Number of primary shards assigned to selected nodes.
  replicationnumber
  Ratio of replica shards to primary shards across all selected nodes.
  totalnumber
  Total number of shards assigned to selected nodes.
  storeobject Required
  Hide store attributes Show store attributes object
  sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  size_in_bytesnumber Required
  Total size, in bytes, of all shards assigned to selected nodes.
  reservednumber | string
  One of:
  ByteSizenumber ByteSizestring
  reserved_in_bytesnumber 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_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_data_set_size_in_bytesnumber
  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.
  mappingsobject Required
  Hide mappings attributes Show mappings attributes object
  field_typesarray[object] Required
  Contains statistics about field data types used in selected nodes.
  Hide field_types attributes Show field_types attributes object
  namestring Required
  countnumber Required
  The number of occurrences of the field type in selected nodes.
  index_countnumber Required
  The number of indices containing the field type in selected nodes.
  indexed_vector_countnumber
  For dense_vector field types, number of indexed vector types in selected nodes.
  indexed_vector_dim_maxnumber
  For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
  indexed_vector_dim_minnumber
  For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
  script_countnumber Generally available; Added in 7.13.0
  The number of fields that declare a script.
  runtime_field_typesarray[object]
  Contains statistics about runtime field data types used in selected nodes.
  Hide runtime_field_types attributes Show runtime_field_types attributes object
  chars_maxnumber Required
  Maximum number of characters for a single runtime field script.
  chars_totalnumber Required
  Total number of characters for the scripts that define the current runtime field data type.
  countnumber Required
  Number of runtime fields mapped to the field data type in selected nodes.
  doc_maxnumber Required
  Maximum number of accesses to doc_values for a single runtime field script
  doc_totalnumber Required
  Total number of accesses to doc_values for the scripts that define the current runtime field data type.
  index_countnumber Required
  Number of indices containing a mapping of the runtime field data type in selected nodes.
  langarray[string] Required
  Script languages used for the runtime fields scripts.
  lines_maxnumber Required
  Maximum number of lines for a single runtime field script.
  lines_totalnumber Required
  Total number of lines for the scripts that define the current runtime field data type.
  namestring Required
  scriptless_countnumber Required
  Number of runtime fields that don’t declare a script.
  shadowed_countnumber Required
  Number of runtime fields that shadow an indexed field.
  source_maxnumber Required
  Maximum number of accesses to _source for a single runtime field script.
  source_totalnumber Required
  Total number of accesses to _source for the scripts that define the current runtime field data type.
  total_field_countnumber
  Total number of fields in all non-system indices.
  total_deduplicated_field_countnumber
  Total number of fields in all non-system indices, accounting for mapping deduplication.
  total_deduplicated_mapping_sizenumber | string
  One of:
  ByteSizenumber ByteSizestring
  total_deduplicated_mapping_size_in_bytesnumber
  Total size of all mappings, in bytes, after deduplication and compression.
  versionsarray[object]
  Contains statistics about analyzers and analyzer components used in selected nodes.
  Hide versions attributes Show versions attributes object
  index_countnumber Required
  primary_shard_countnumber Required
  total_primary_bytesnumber Required
  versionstring Required
- nodesobject Required
  Hide nodes attributes Show nodes attributes object
  countobject Required
  Hide count attributes Show count attributes object
  coordinating_onlynumber Required
  datanumber Required
  data_coldnumber Required
  data_contentnumber Required
  data_frozennumber Generally available; Added in 7.13.0
  data_hotnumber Required
  data_warmnumber Required
  ingestnumber Required
  masternumber Required
  mlnumber Required
  remote_cluster_clientnumber Required
  totalnumber Required
  transformnumber Required
  voting_onlynumber Required
  discovery_typesobject Required
  Contains statistics about the discovery types used by selected nodes.
  Hide discovery_types attribute Show discovery_types attribute object
  *number Additional properties
  fsobject Required
  Hide fs attributes Show fs attributes object
  available_in_bytesnumber 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_bytesnumber Required
  Total number of unallocated bytes in file stores across all selected nodes.
  total_in_bytesnumber Required
  Total size, in bytes, of all file stores across all selected nodes.
  indexing_pressureobject Required
  Hide indexing_pressure attribute Show indexing_pressure attribute object
  memoryobject Required
  Hide memory attributes Show memory attributes object
  currentobject Required
  Hide current attributes Show current attributes object
  all_in_bytesnumber Required
  combined_coordinating_and_primary_in_bytesnumber Required
  coordinating_in_bytesnumber Required
  coordinating_rejectionsnumber
  primary_in_bytesnumber Required
  primary_rejectionsnumber
  replica_in_bytesnumber Required
  replica_rejectionsnumber
  limit_in_bytesnumber Required
  totalobject Required
  Hide total attributes Show total attributes object
  all_in_bytesnumber Required
  combined_coordinating_and_primary_in_bytesnumber Required
  coordinating_in_bytesnumber Required
  coordinating_rejectionsnumber
  primary_in_bytesnumber Required
  primary_rejectionsnumber
  replica_in_bytesnumber Required
  replica_rejectionsnumber
  ingestobject Required
  Hide ingest attributes Show ingest attributes object
  number_of_pipelinesnumber Required
  processor_statsobject Required
  Hide processor_stats attribute Show processor_stats attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  countnumber Required
  currentnumber Required
  failednumber Required
  timestring
  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.
  jvmobject Required
  Hide jvm attributes Show jvm attributes object
  Time unit for milliseconds
  memobject Required
  Hide mem attributes Show mem attributes object
  heap_max_in_bytesnumber Required
  Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
  heap_used_in_bytesnumber Required
  Memory, in bytes, currently in use by the heap across all selected nodes.
  threadsnumber Required
  Number of active threads in use by JVM across all selected nodes.
  versionsarray[object] Required
  Contains statistics about the JVM versions used by selected nodes.
  Hide versions attributes Show versions attributes object
  bundled_jdkboolean Required
  Always true. All distributions come with a bundled Java Development Kit (JDK).
  countnumber Required
  Total number of selected nodes using JVM.
  using_bundled_jdkboolean Required
  If true, a bundled JDK is in use by JVM.
  versionstring Required
  vm_namestring Required
  Name of the JVM.
  vm_vendorstring Required
  Vendor of the JVM.
  vm_versionstring Required
  network_typesobject Required
  Hide network_types attributes Show network_types attributes object
  http_typesobject 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_typesobject Required
  Contains statistics about the transport network types used by selected nodes.
  Hide transport_types attribute Show transport_types attribute object
  *number Additional properties
  osobject Required
  Hide os attributes Show os attributes object
  allocated_processorsnumber 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.
  architecturesarray[object]
  Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
  Hide architectures attributes Show architectures attributes object
  archstring Required
  Name of an architecture used by one or more selected nodes.
  countnumber Required
  Number of selected nodes using the architecture.
  available_processorsnumber Required
  Number of processors available to JVM across all selected nodes.
  memobject Required
  Hide mem attributes Show mem attributes object
  adjusted_total_in_bytesnumber Generally available; Added in 7.16.0
  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_bytesnumber Required
  Amount, in bytes, of free physical memory across all selected nodes.
  free_percentnumber Required
  Percentage of free physical memory across all selected nodes.
  total_in_bytesnumber Required
  Total amount, in bytes, of physical memory across all selected nodes.
  used_in_bytesnumber Required
  Amount, in bytes, of physical memory in use across all selected nodes.
  used_percentnumber Required
  Percentage of physical memory in use across all selected nodes.
  namesarray[object] Required
  Contains statistics about operating systems used by selected nodes.
  Hide names attributes Show names attributes object
  countnumber Required
  Number of selected nodes using the operating system.
  namestring Required
  pretty_namesarray[object] Required
  Contains statistics about operating systems used by selected nodes.
  Hide pretty_names attributes Show pretty_names attributes object
  countnumber Required
  Number of selected nodes using the operating system.
  pretty_namestring Required
  packaging_typesarray[object] Required
  Contains statistics about Elasticsearch distributions installed on selected nodes.
  Hide packaging_types attributes Show packaging_types attributes object
  countnumber Required
  Number of selected nodes using the distribution flavor and file type.
  flavorstring Required
  Type of Elasticsearch distribution. This is always default.
  typestring Required
  File type (such as tar or zip) used for the distribution package.
  pluginsarray[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
  classnamestring Required
  descriptionstring Required
  elasticsearch_versionstring Required
  extended_pluginsarray[string] Required
  has_native_controllerboolean Required
  java_versionstring Required
  namestring Required
  versionstring Required
  licensedboolean Required
  processobject Required
  Hide process attributes Show process attributes object
  cpuobject Required
  Hide cpu attribute Show cpu attribute object
  percentnumber Required
  Percentage of CPU used across all selected nodes. Returns -1 if not supported.
  open_file_descriptorsobject Required
  Hide open_file_descriptors attributes Show open_file_descriptors attributes object
  avgnumber Required
  Average number of concurrently open file descriptors. Returns -1 if not supported.
  maxnumber Required
  Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.
  minnumber Required
  Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.
  versionsarray[string] Required
  Array of Elasticsearch versions used on selected nodes.
- statusstring Required
  Values are green, GREEN, yellow, YELLOW, red, or RED.
- timestampnumber Required
  Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.
- ccsobject Required
  Hide ccs attributes Show ccs attributes object
  clustersobject
  Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if include_remotes option is set to true.
  Hide clusters attribute Show clusters attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  cluster_uuidstring Required
  The UUID of the remote cluster.
  modestring Required
  The connection mode used to communicate with the remote cluster.
  skip_unavailableboolean Required
  The skip_unavailable setting used for this remote cluster.
  transport_compressstring Required
  Transport compression setting used for this remote cluster.
  statusstring Required
  Values are green, GREEN, yellow, YELLOW, red, or RED.
  versionarray[string] Required
  The list of Elasticsearch versions used by the nodes on the remote cluster.
  nodes_countnumber Required
  The total count of nodes in the remote cluster.
  shards_countnumber Required
  The total number of shards in the remote cluster.
  indices_countnumber Required
  The total number of indices in the remote cluster.
  indices_total_size_in_bytesnumber Required
  Total data set size, in bytes, of all shards assigned to selected nodes.
  indices_total_sizestring
  Total data set size of all shards assigned to selected nodes, as a human-readable string.
  max_heap_in_bytesnumber Required
  Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.
  max_heapstring
  Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.
  mem_total_in_bytesnumber Required
  Total amount, in bytes, of physical memory across the nodes of the remote cluster.
  mem_totalstring
  Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.
  _searchobject Required
  Hide _search attributes Show _search attributes object
  totalnumber Required
  The total number of cross-cluster search requests that have been executed by the cluster.
  successnumber Required
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  skippednumber Required
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  tookobject Required
  Hide took attributes Show took attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  took_mrt_trueobject
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  took_mrt_falseobject
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  remotes_per_search_maxnumber Required
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  remotes_per_search_avgnumber Required
  The average number of remote clusters that were queried in a single cross-cluster search request.
  failure_reasonsobject Required
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  Hide failure_reasons attribute Show failure_reasons attribute object
  *number Additional properties
  featuresobject Required
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  Hide features attribute Show features attribute object
  *number Additional properties
  clientsobject Required
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  Hide clients attribute Show clients attribute object
  *number Additional properties
  clustersobject Required
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  Hide clusters attribute Show clusters attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  totalnumber Required
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  skippednumber Required
  The total number of cross-cluster search requests for which this cluster was skipped.
  tookobject Required
  _esqlobject
  Hide _esql attributes Show _esql attributes object
  totalnumber Required
  The total number of cross-cluster search requests that have been executed by the cluster.
  successnumber Required
  The total number of cross-cluster search requests that have been successfully executed by the cluster.
  skippednumber Required
  The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
  tookobject Required
  Hide took attributes Show took attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  took_mrt_trueobject
  Hide took_mrt_true attributes Show took_mrt_true attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  took_mrt_falseobject
  Hide took_mrt_false attributes Show took_mrt_false attributes object
  Time unit for milliseconds
  Time unit for milliseconds
  Time unit for milliseconds
  remotes_per_search_maxnumber Required
  The maximum number of remote clusters that were queried in a single cross-cluster search request.
  remotes_per_search_avgnumber Required
  The average number of remote clusters that were queried in a single cross-cluster search request.
  failure_reasonsobject Required
  Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
  Hide failure_reasons attribute Show failure_reasons attribute object
  *number Additional properties
  featuresobject Required
  The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).
  Hide features attribute Show features attribute object
  *number Additional properties
  clientsobject Required
  Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.
  Hide clients attribute Show clients attribute object
  *number Additional properties
  clustersobject Required
  Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).
  Hide clusters attribute Show clusters attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  totalnumber Required
  The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
  skippednumber Required
  The total number of cross-cluster search requests for which this cluster was skipped.
  tookobject Required

GET /_cluster/stats

GET _cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*

resp = client.cluster.stats(
    human=True,
    filter_path="indices.mappings.total_deduplicated_mapping_size*",
)

const response = await client.cluster.stats({
  human: "true",
  filter_path: "indices.mappings.total_deduplicated_mapping_size*",
});

response = client.cluster.stats(
  human: "true",
  filter_path: "indices.mappings.total_deduplicated_mapping_size*"
)

$resp = $client->cluster()->stats([
    "human" => "true",
    "filter_path" => "indices.mappings.total_deduplicated_mapping_size*",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cluster/stats?human&filter_path=indices.mappings.total_deduplicated_mapping_size*"

Query parameters

Responses

reasonstring | null

sizenumber | string

memory_sizenumber | string

memory_sizenumber | string

doc_values_memorynumber | string

fixed_bit_setnumber | string

index_writer_memorynumber | string

memorynumber | string

norms_memorynumber | string

points_memorynumber | string

stored_memorynumber | string

terms_memorynumber | string

term_vectory_memorynumber | string

version_map_memorynumber | string

sizenumber | string

reservednumber | string

total_data_set_sizenumber | string

total_deduplicated_mapping_sizenumber | string