Skip to content

Adds an external link to Cluster allocation explain API spec #4523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 12, 2025
Merged

Adds an external link to Cluster allocation explain API spec #4523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1bb1a0
Adds an external link to Cluster allocation explain API spec.
szabosteve Jun 11, 2025
b6df465
Adds clarifying sentence.
szabosteve Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ clear-repositories-metering-archive-api,https://www.elastic.co/docs/api/doc/elas
clear-scroll-api,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-clear-scroll
clear-trained-model,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache
cluster-allocation-explain,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-allocation-explain
cluster-allocation-explain-examples,https://www.elastic.co/docs/troubleshoot/elasticsearch/cluster-allocation-api-examples
cluster-get-settings,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-get-settings
cluster-health,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-health
cluster-info,https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-info
Expand Down
2 changes: 2 additions & 0 deletions specification/cluster/allocation_explain/ClusterAllocationExplainRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ import { Duration } from '@_types/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.
* @rest_spec_name cluster.allocation_explain
* @availability stack since=5.0.0 stability=stable
* @availability serverless stability=stable visibility=private
* @doc_id cluster-allocation-explain
* @ext_doc_id cluster-allocation-explain-examples
* @doc_tag cluster
*/
export interface Request extends RequestBase {
Expand Down
Loading