# Cluster

class elasticsearch.client.ClusterClient

  To use this client, access `client.cluster` from an `Elasticsearch` client. For example:

      from elasticsearch import Elasticsearch

      # Create the client instance
      client = Elasticsearch(...)
      # Use the cluster client
      client.cluster.<method>(...)

  allocation_explain(*, current_node=None, error_trace=None, filter_path=None, human=None, include_disk_info=None, include_yes_decisions=None, index=None, master_timeout=None, pretty=None, primary=None, shard=None, body=None)

    Explain the shard allocations.

    Get explanations for shard allocations in the cluster. This API accepts the current_node, index, primary and shard parameters in the request body or in query parameters, but not in both at the same time. For unassigned shards, it provides an explanation for why the shard is unassigned. For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain

    Parameters:

      - current_node (str | None) – Explain a shard only if it is currently located on the specified node name or node ID.

      - include_disk_info (bool | None) – If true, returns information about disk usage and shard sizes.

      - include_yes_decisions (bool | None) – If true, returns YES decisions in explanation.

      - index (str | None) – The name of the index that you would like an explanation for.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - primary (bool | None) – If true, returns an explanation for the primary shard for the specified shard ID.

      - shard (int | None) – An identifier for the shard that you would like an explanation for.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  delete_component_template(*, name, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)

    Delete component templates.

    Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list or wildcard expression of component template names used to limit the request.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  delete_voting_config_exclusions(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, wait_for_removal=None)

    Clear cluster voting config exclusions.

    Remove master-eligible nodes from the voting configuration exclusion list.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions

    Parameters:

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - wait_for_removal (bool | None) – Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  exists_component_template(*, name, error_trace=None, filter_path=None, human=None, local=None, master_timeout=None, pretty=None)

    Check component templates.

    Returns information about whether a particular component template exists.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

    Parameters:

      - name (str | Sequence[str]) – Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.

      - local (bool | None) – If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      HeadApiResponse

  get_component_template(*, name=None, error_trace=None, filter_path=None, flat_settings=None, human=None, include_defaults=None, local=None, master_timeout=None, pretty=None, settings_filter=None)

    Get component templates.

    Get information about component templates.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

    Parameters:

      - name (str | None) – Name of component template to retrieve. Wildcard (*) expressions are supported.

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - include_defaults (bool | None) – Return all default configurations for the component template

      - local (bool | None) – If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - settings_filter (str | Sequence[str] | None) – Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  get_settings(*, error_trace=None, filter_path=None, flat_settings=None, human=None, include_defaults=None, master_timeout=None, pretty=None, timeout=None)

    Get cluster-wide settings.

    By default, it returns only settings that have been explicitly defined.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings

    Parameters:

      - flat_settings (bool | None) – If true, returns settings in flat format.

      - include_defaults (bool | None) – If true, also returns default values for all other cluster settings, reflecting the values in the elasticsearch.yml file of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in their elasticsearch.yml config files then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the GET _nodes/settings API to fetch the settings for each individual node in your cluster.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  health(*, index=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, level=None, local=None, master_timeout=None, pretty=None, timeout=None, wait_for_active_shards=None, wait_for_events=None, wait_for_no_initializing_shards=None, wait_for_no_relocating_shards=None, wait_for_nodes=None, wait_for_status=None)

    Get the cluster health status.

    You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the stream’s backing indices.

    The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. The index level status is controlled by the worst shard status.

    One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. The cluster status is controlled by the worst index status.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health

    Parameters:

      - index (str | Sequence[str] | None) – A comma-separated list of data streams, indices, and index aliases that limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Expand wildcard expression to concrete indices that are open, closed or both.

      - level (str | Literal['cluster', 'indices', 'shards'] | None) – Return health information at a specific level of detail.

      - local (bool | None) – If true, retrieve information from the local node only. If false, retrieve information from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - wait_for_active_shards (int | str | Literal['all', 'index-setting'] | None) – Wait for the specified number of active shards. Use all to wait for all shards in the cluster to be active. Use 0 to not wait.

      - wait_for_events (str | Literal['high', 'immediate', 'languid', 'low', 'normal', 'urgent'] | None) – Wait until all currently queued events with the given priority are processed.

      - wait_for_no_initializing_shards (bool | None) – Wait (until the timeout expires) for the cluster to have no shard initializations. If false, the request does not wait for initializing shards.

      - wait_for_no_relocating_shards (bool | None) – Wait (until the timeout expires) for the cluster to have no shard relocations. If false, the request not wait for relocating shards.

      - wait_for_nodes (int | str | None) – Wait until the specified number (N) of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, use the notations ge(N), le(N), gt(N), and lt(N).

      - wait_for_status (str | Literal['green', 'red', 'unavailable', 'unknown', 'yellow'] | None) – Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status). A green status is better than yellow and yellow is better than red. By default, the request does not wait for a particular status.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  info(*, target, error_trace=None, filter_path=None, human=None, pretty=None)

    Get cluster info.

    Returns basic information about the cluster.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info

    Parameters:

      - target (Sequence[str | Literal['_all', 'http', 'ingest', 'script', 'thread_pool']] | str | ~typing.Literal['_all', 'http', 'ingest', 'script', 'thread_pool']) – Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  pending_tasks(*, error_trace=None, filter_path=None, human=None, local=None, master_timeout=None, pretty=None)

    Get the pending cluster tasks.

    Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

    NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-pending-tasks

    Parameters:

      - local (bool | None) – If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  post_voting_config_exclusions(*, error_trace=None, filter_path=None, human=None, master_timeout=None, node_ids=None, node_names=None, pretty=None, timeout=None)

    Update voting configuration exclusions.

    Update the cluster voting config exclusions by node IDs or node names. By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes.

    Clusters should have no voting configuration exclusions in normal operation. Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. This API waits for the nodes to be fully removed from the cluster before it returns. If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster.

    A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. In that case, you may safely retry the call.

    NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-post-voting-config-exclusions

    Parameters:

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node.

      - node_ids (str | Sequence[str] | None) – A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names.

      - node_names (str | Sequence[str] | None) – A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  put_component_template(*, name, template=None, cause=None, create=None, deprecated=None, error_trace=None, filter_path=None, human=None, master_timeout=None, meta=None, pretty=None, version=None, body=None)

    Create or update a component template.

    Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

    An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.

    Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

    Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

    You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

    Applying component templates

    You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template's `composed_of` list.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-component-template

    Parameters:

      - name (str) – Name of the component template to create. Elasticsearch includes the following built-in component templates: logs-mappings; logs-settings; metrics-mappings; metrics-settings;`synthetics-mapping`; synthetics-settings. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the version for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set stack.templates.enabled to false using the cluster update settings API.

      - template (Mapping[str, Any] | None) – The template to be applied which includes mappings, settings, or aliases configuration.

      - cause (str | None) – User defined reason for create the component template.

      - create (bool | None) – If true, this request cannot replace or update existing component templates.

      - deprecated (bool | None) – Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - meta (Mapping[str, Any] | None) – Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset _meta, replace the template without specifying this information.

      - version (int | None) – Version number used to manage component templates externally. This number isn’t automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  put_settings(*, error_trace=None, filter_path=None, flat_settings=None, human=None, master_timeout=None, persistent=None, pretty=None, timeout=None, transient=None, body=None)

    Update the cluster settings.

    Configure and update dynamic settings on a running cluster. You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`.

    Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. You can also reset transient or persistent settings by assigning them a null value.

    If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting.

    TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. Only use `elasticsearch.yml` for static cluster settings and node settings. The API doesn’t require a restart and ensures a setting’s value is the same on all nodes.

    WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings

    Parameters:

      - flat_settings (bool | None) – Return settings in flat format

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a connection to the master node.

      - persistent (Mapping[str, Any] | None) – The settings that persist after the cluster restarts.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The period to wait for a response.

      - transient (Mapping[str, Any] | None) – The settings that do not persist after the cluster restarts.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  remote_info(*, error_trace=None, filter_path=None, human=None, pretty=None)

    Get remote cluster information.

    Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.

    > info This API returns information that reflects current state on the local cluster. The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the resolve cluster endpoint.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-remote-info

    Parameters:

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  reroute(*, commands=None, dry_run=None, error_trace=None, explain=None, filter_path=None, human=None, master_timeout=None, metric=None, pretty=None, retry_failed=None, timeout=None, body=None)

    Reroute the cluster.

    Manually change the allocation of individual shards in the cluster. For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.

    It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.

    The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.

    The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.

    Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-reroute

    Parameters:

      - commands (Sequence[Mapping[str, Any]] | None) – Defines the commands to perform.

      - dry_run (bool | None) – If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.

      - explain (bool | None) – If true, then the response contains an explanation of why the commands can or cannot run.

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      - metric (str | Sequence[str] | None) – Limits the information returned to the specified metrics.

      - retry_failed (bool | None) – If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

      - body (Dict[str, Any] | None)

    Return type:

      ObjectApiResponse[Any]

  state(*, metric=None, index=None, allow_no_indices=None, error_trace=None, expand_wildcards=None, filter_path=None, flat_settings=None, human=None, ignore_unavailable=None, local=None, master_timeout=None, pretty=None, wait_for_metadata_version=None, wait_for_timeout=None)

    Get the cluster state.

    Get comprehensive information about the state of the cluster.

    The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.

    The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.

    By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.

    Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.

    WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-state

    Parameters:

      - metric (Sequence[str | Literal['_all', 'blocks', 'customs', 'master_node', 'metadata', 'nodes', 'routing_nodes', 'routing_table', 'version']] | str | ~typing.Literal['_all', 'blocks', 'customs', 'master_node', 'metadata', 'nodes', 'routing_nodes', 'routing_table', 'version'] | None) – Limit the information returned to the specified metrics.

      - index (str | Sequence[str] | None) – A comma-separated list of index names; use _all or empty string to perform the operation on all indices

      - allow_no_indices (bool | None) – Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

      - expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – Whether to expand wildcard expression to concrete indices that are open, closed or both

      - flat_settings (bool | None) – Return settings in flat format

      - ignore_unavailable (bool | None) – Whether specified concrete indices should be ignored when unavailable (missing or closed)

      - local (bool | None) – Return local information, do not retrieve the state from master node

      - master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Timeout for waiting for new cluster state in case it is blocked

      - wait_for_metadata_version (int | None) – Wait for the metadata version to be equal or greater than the specified metadata version

      - wait_for_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – The maximum time to wait for wait_for_metadata_version before timing out

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]

  stats(*, node_id=None, error_trace=None, filter_path=None, human=None, include_remotes=None, pretty=None, timeout=None)

    Get cluster statistics.

    Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

    https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-stats

    Parameters:

      - node_id (str | Sequence[str] | None) – Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

      - include_remotes (bool | None) – Include remote cluster data into the response

      - timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

      - error_trace (bool | None)

      - filter_path (str | Sequence[str] | None)

      - human (bool | None)

      - pretty (bool | None)

    Return type:

      ObjectApiResponse[Any]