68 lines
3.9 KiB
Plaintext
68 lines
3.9 KiB
Plaintext
[[reference-health_report]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.healthReport
|
|
|
|
Returns the health of the cluster.
|
|
|
|
{ref}/health-api.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(HealthReportRequest, options?): Promise<HealthReportResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `HealthReportRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface HealthReportRequest extends <<RequestBase>> {
|
|
feature?: string | string[]
|
|
timeout?: <<Duration>>
|
|
verbose?: boolean
|
|
size?: <<integer>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `HealthReportResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface HealthReportResponse {
|
|
cluster_name: string
|
|
indicators: HealthReportIndicators
|
|
status?: HealthReportIndicatorHealthStatus
|
|
}
|
|
----
|
|
|