OpenSearch/docs/reference/cluster
Lee Hinman e53a43800e Add `explain` flag support to the reroute API
By specifying the `explain` flag, an explanation for the reason a
command can or cannot be executed is returned. No allocation commands
are actually performed.

Returns a response similar to:

{
  "state": {...cluster state...},
  "acknowledged": true,
  "explanations" : [ {
    "command" : "cancel",
      "parameters" : {
        "index" : "decide",
        "shard" : 0,
        "node" : "IvpoKRdtRiGrQ_WKtt4_4w",
        "allow_primary" : false
      },
      "decisions" : [ {
        "decider" : "cancel_allocation_command",
        "decision" : "YES",
        "explanation" : "..."
        } ]
     }, {
      "command" : "move",
      "parameters" : {
        "index" : "decide",
        "shard" : 0,
        "from_node" : "IvpoKRdtRiGrQ_WKtt4_4w",
        "to_node" : "IvpoKRdtRiGrQ_WKtt4_4w"
       },
       "decisions" : [ {
         "decider" : "same_shard",
         "decision" : "NO",
         "explanation" : "shard cannot be allocated on same node [IvpoKRdtRiGrQ_WKtt4_4w] it already exists on"
       },
       etc
       ]
  }]
}

also removes AllocationExplanation from cluster state

Closes #2483
Closes #5169
2014-02-27 09:48:51 -07:00
..
health.asciidoc Clean up wording to reduce confusion 2013-10-21 12:37:50 +01:00
nodes-hot-threads.asciidoc [DOCS] Removed the experimental label from Tribe, Hot Threads 2014-02-06 14:19:17 +01:00
nodes-info.asciidoc Migrating NodesInfo API to use plugins instead of singular plugin 2014-02-11 10:05:10 +01:00
nodes-shutdown.asciidoc Add more anchor links to documentation 2013-09-30 13:13:16 -06:00
nodes-stats.asciidoc [DOCS] Remove clear flag from node-stats as it is not used anymore 2014-02-17 15:20:12 +01:00
pending.asciidoc [DOCS] Doc'ed cluster pending tasks 2013-11-29 08:21:26 +01:00
reroute.asciidoc Add `explain` flag support to the reroute API 2014-02-27 09:48:51 -07:00
state.asciidoc add version and master_node flags to cluster state 2014-02-10 02:24:03 +01:00
stats.asciidoc Removed 0.90.* deprecation and addition notifications 2014-02-07 20:52:49 +01:00
update-settings.asciidoc [DOCS] added coming tags for `zen.discovery.publish_timeout` made dynamic 2014-02-12 15:24:38 +01:00