Skip to content

Commit 1541b14

Browse files
Add Query Parameters to Cluster Allocation Explain API (#129342)
The cluster allocation explain API now accepts parameters via the request body, via path parameters passed in the URL, but not via both. Issue: #127028
1 parent 9d4c3f8 commit 1541b14

File tree

6 files changed

+1044
-37
lines changed

6 files changed

+1044
-37
lines changed

rest-api-spec/src/main/resources/rest-api-spec/api/cluster.allocation_explain.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,22 @@
2222
]
2323
},
2424
"params":{
25+
"index": {
26+
"type": "string",
27+
"description": "Specifies the name of the index that you would like an explanation for"
28+
},
29+
"shard": {
30+
"type": "number",
31+
"description": "Specifies the ID of the shard that you would like an explanation for"
32+
},
33+
"primary": {
34+
"type":"boolean",
35+
"description":"If true, returns explanation for the primary shard for the given shard ID"
36+
},
37+
"current_node": {
38+
"type": "string",
39+
"description": "Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node"
40+
},
2541
"master_timeout":{
2642
"type":"time",
2743
"description":"Timeout for connection to master node"

0 commit comments

Comments
 (0)