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

70 lines
4.0 KiB
Plaintext

[[reference-cat-master]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.cat.master
Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
{ref}/cat-master.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CatMasterRequest, options?): Promise<CatMasterResponse>
----
[discrete]
==== CatMasterRequest
[pass]
++++
<pre>
++++
interface CatMasterRequest extends CatCatRequestBase {
}
[pass]
++++
</pre>
++++
[discrete]
==== CatMasterResponse
[pass]
++++
<pre>
++++
type CatMasterResponse = CatMasterMasterRecord[]
[pass]
++++
</pre>
++++