[[reference-cluster-state]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.state

Returns a comprehensive information about the state of the cluster.

{ref}/cluster-state.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(ClusterStateRequest, options?): Promise<ClusterStateResponse>
----

[discrete]
===== `ClusterStateRequest`

[source,ts]
----
interface ClusterStateRequest extends <<shared-type-request-base, RequestBase>> {
  metric?: <<shared-type-metrics, Metrics>>
  index?: <<shared-type-indices, Indices>>
  allow_no_indices?: boolean
  expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
  flat_settings?: boolean
  ignore_unavailable?: boolean
  local?: boolean
  master_timeout?: <<shared-type-duration, Duration>>
  wait_for_metadata_version?: <<shared-type-version-number, VersionNumber>>
  wait_for_timeout?: <<shared-type-duration, Duration>>
}
----

[discrete]
===== `ClusterStateResponse`

[source,ts]
----
type ClusterStateResponse = any
----