Files
elasticsearch-js/docs/reference-cluster-info.asciidoc
2024-12-05 14:46:51 -06:00

77 lines
3.9 KiB
Plaintext

[[reference-cluster-info]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.cluster.info
Get cluster info. Returns basic information about the cluster.
{ref}/cluster-info.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(ClusterInfoRequest, options?): Promise<ClusterInfoResponse>
----
[discrete]
==== ClusterInfoRequest
[pass]
++++
<pre>
++++
interface ClusterInfoRequest extends <<RequestBase>> {
target: <<ClusterInfoTargets>>
}
[pass]
++++
</pre>
++++
[discrete]
==== ClusterInfoResponse
[pass]
++++
<pre>
++++
interface ClusterInfoResponse {
cluster_name: <<Name>>
http?: NodesHttp
ingest?: NodesIngest
thread_pool?: Record<string, NodesThreadCount>
script?: NodesScripting
}
[pass]
++++
</pre>
++++