OpenSearch/rest-api-spec/api
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
..
bulk.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cat.aliases.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.allocation.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.count.json [SPEC] Added missing cat endpoints. count and recovery 2014-01-16 22:09:48 +01:00
cat.health.json [SPEC] Added missing cat endpoints. count and recovery 2014-01-16 22:09:48 +01:00
cat.help.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.indices.json [SPEC] Added missing cat endpoints. count and recovery 2014-01-16 22:09:48 +01:00
cat.master.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.nodes.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.pending_tasks.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.recovery.json [SPEC] Added missing cat endpoints. count and recovery 2014-01-16 22:09:48 +01:00
cat.shards.json [SPEC] Fixed cat.* spec files - were missing the endpoints 2014-01-16 19:43:58 +01:00
cat.thread_pool.json [TEST] Added REST tests for _cat/thread_pool endpoint 2014-02-10 16:20:03 +01:00
clear_scroll.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cluster.get_settings.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cluster.health.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cluster.pending_tasks.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cluster.put_settings.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
cluster.reroute.json Add `explain` flag support to the reroute API 2014-02-27 09:48:51 -07:00
cluster.state.json Cluster state toXContent serialization only returns needed data 2014-01-27 12:04:57 +01:00
cluster.stats.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
count.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
count_percolate.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
delete.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
delete_by_query.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
exists.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
explain.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
get.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
get_source.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
index.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.analyze.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.clear_cache.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.close.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.create.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.delete.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.delete_alias.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.delete_mapping.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.delete_template.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.delete_warmer.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.exists.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.exists_alias.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.exists_template.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.exists_type.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.flush.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_alias.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_aliases.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_field_mapping.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_mapping.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_settings.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_template.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.get_warmer.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.open.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.optimize.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.put_alias.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.put_mapping.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.put_settings.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.put_template.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.put_warmer.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.refresh.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.segments.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.snapshot_index.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.stats.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.status.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.update_aliases.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
indices.validate_query.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
info.json [SPEC] Separated info.json into info and ping.json (GET vs HEAD) 2014-01-16 17:07:47 +01:00
mget.json Revert mget yaml test changes 2014-01-27 11:28:32 +01:00
mlt.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
mpercolate.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
msearch.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
mtermvectors.json [SPEC] Renamed termvectors.* to termvector and mtermvectors 2014-01-21 16:31:50 +01:00
nodes.hot_threads.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
nodes.info.json Migrating NodesInfo API to use plugins instead of singular plugin 2014-02-11 10:05:10 +01:00
nodes.shutdown.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
nodes.stats.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
percolate.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
ping.json [SPEC] Fixed bad name in ping.json 2014-01-16 19:54:25 +01:00
scroll.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
search.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
snapshot.create.json [SPEC] Various API fixes 2014-01-20 11:14:11 +01:00
snapshot.create_repository.json [SPEC] Various API fixes 2014-01-20 11:14:11 +01:00
snapshot.delete.json [SPEC] Various API fixes 2014-01-20 11:14:11 +01:00
snapshot.delete_repository.json [SPEC] Various API fixes 2014-01-20 11:14:11 +01:00
snapshot.get.json [SPEC] Fix cardinality of the repository parameter in get snapshot action 2014-01-20 12:56:32 -05:00
snapshot.get_repository.json Added base Request class for read operations that usually happen on the master but can be executed locally. 2014-01-20 12:35:48 +01:00
snapshot.restore.json [SPEC] Various API fixes 2014-01-20 11:14:11 +01:00
suggest.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
termvector.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00
update.json [SPEC] Updated docs URLs to point to master 2014-01-22 14:40:31 +01:00