Manage cluster.

author

- Hongxin Liang

See also

- http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html

license

- Apache License Version 2.0

 health(+Ps, +Index, -Reply) is semidet

 health(+Ps, +Index, +Params, -Reply) is semidet

Get a very simple status on the health of the cluster. See here.

 pending_tasks(+Ps, -Reply) is semidet

 pending_tasks(+Ps, +Params, -Reply) is semidet

The pending cluster tasks API returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. See here.

 state(+Ps, +Index, +Metric, -Reply) is semidet

 state(+Ps, +Index, +Metric, +Params, -Reply) is semidet

Get a comprehensive state information of the whole cluster. See here.

 stats(+Ps, +NodeID, -Reply) is semidet

 stats(+Ps, +NodeID, +Params, -Reply) is semidet

The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. The API returns basic index metrics and information about the current nodes that form the cluster. See here.

 reroute(+Ps, +Body, -Reply) is semidet

 reroute(+Ps, +Params, +Body, -Reply) is semidet

Explicitly execute a cluster reroute allocation command including specific commands. See here.

 get_settings(+Ps, -Reply) is semidet

 get_settings(+Ps, +Params, -Reply) is semidet

Get cluster settings. See here.

 put_settings(+Ps, +Body, -Reply) is semidet

 put_settings(+Ps, +Params, +Body, -Reply) is semidet

Update cluster wide specific settings. See here.

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.

 health(Arg1, Arg2, Arg3, Arg4)

 pending_tasks(Arg1, Arg2, Arg3)

 state(Arg1, Arg2, Arg3, Arg4, Arg5)

 stats(Arg1, Arg2, Arg3, Arg4)

 reroute(Arg1, Arg2, Arg3, Arg4)

 get_settings(Arg1, Arg2, Arg3)

 put_settings(Arg1, Arg2, Arg3, Arg4)