elasticsearch-js/docs/reference/api/Cluster.md

Cluster

Constructor

::: new Cluster(transport: Transport); :::

Properties

Name	Type	Description
acceptedParams	Record<string, { path: string[]; body: string[]; query: string[]; }>
transport	Transport

Methods

Name	Signature	Description
allocationExplain	allocationExplain(this: [That](./That.md), params?: [ClusterAllocationExplainRequest](./ClusterAllocationExplainRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[ClusterAllocationExplainResponse](./ClusterAllocationExplainResponse.md)>;	Explain the shard allocations. Get explanations for shard allocations in the cluster. 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.