66 lines
3.9 KiB
Plaintext
66 lines
3.9 KiB
Plaintext
[[reference-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.info
|
|
|
|
Get cluster info. Returns basic information about the cluster.
|
|
|
|
{ref}/index.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(InfoRequest, options?): Promise<InfoResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `InfoRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface InfoRequest extends <<shared-type-request-base, RequestBase>> {
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `InfoResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface InfoResponse {
|
|
cluster_name: <<shared-type-name, Name>>
|
|
cluster_uuid: <<shared-type-uuid, Uuid>>
|
|
name: <<shared-type-name, Name>>
|
|
tagline: string
|
|
version: <<shared-type-elasticsearch-version-info, ElasticsearchVersionInfo>>
|
|
}
|
|
----
|
|
|