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

84 lines
4.1 KiB
Plaintext

[[reference-nodes-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.nodes.stats]]
=== client.nodes.stats
Returns cluster nodes statistics.
{ref}/cluster-nodes-stats.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(NodesStatsRequest, options?): Promise<NodesStatsResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface NodesStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
metric?: <<Metrics>>
index_metric?: <<Metrics>>
completion_fields?: <<Fields>>
fielddata_fields?: <<Fields>>
fields?: <<Fields>>
groups?: boolean
include_segment_file_sizes?: boolean
level?: <<Level>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
types?: string[]
include_unloaded_segments?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type NodesStatsResponse = NodesStatsResponseBase
[pass]
++++
</pre>
++++