Files
elasticsearch-js/docs/reference-indices-stats.asciidoc
2024-12-05 14:46:52 -06:00

86 lines
4.3 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[[reference-indices-stats]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
[[client.indices.stats]]
=== client.indices.stats
Returns statistics for one or more indices. For data streams, the API retrieves statistics for the streams backing indices.
{ref}/indices-stats.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesStatsRequest, options?): Promise<IndicesStatsResponse>
----
[discrete]
==== IndicesStatsRequest
[pass]
++++
<pre>
++++
interface IndicesStatsRequest extends <<RequestBase>> {
metric?: <<Metrics>>
index?: <<Indices>>
completion_fields?: <<Fields>>
expand_wildcards?: <<ExpandWildcards>>
fielddata_fields?: <<Fields>>
fields?: <<Fields>>
forbid_closed_indices?: boolean
groups?: string | string[]
include_segment_file_sizes?: boolean
include_unloaded_segments?: boolean
level?: <<Level>>
}
[pass]
++++
</pre>
++++
[discrete]
==== IndicesStatsResponse
[pass]
++++
<pre>
++++
interface IndicesStatsResponse {
indices?: Record<string, IndicesStatsIndicesStats>
_shards: <<ShardStatistics>>
_all: IndicesStatsIndicesStats
}
[pass]
++++
</pre>
++++