elasticsearch/docs/reference/cluster
David Turner dc26886ee1
Clarify cluster state API docs (#82930)
The `GET _cluster/state` API is really only suitable for debugging or
diagnostics. Its response format is not documented since it changes
fairly freely between versions.

Today we mention in its docs that this API is unstable, and deliberately
omit a description of its response format, but we don't explicitly say
that it's only for diagnostics and is unsuitable for consumption by
external tools that might try and use it for monitoring.

This commit adjusts the docs to give some more explicit guidance about
how it should and shouldn't be used.
2022-01-24 10:09:45 -05:00
..
allocation-explain.asciidoc Clarify allocation explain if random shard chosen (#75670) 2021-08-02 15:14:09 +01:00
get-settings.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
health.asciidoc Revert "Return 200 OK response code for a cluster health timeout (#78968)" (#80821) 2021-11-18 19:55:16 +01:00
nodes-hot-threads.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00
nodes-info.asciidoc Add tests/fix docs for nodes info API (#79223) 2021-10-15 15:57:52 +01:00
nodes-reload-secure-settings.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
nodes-stats.asciidoc [docs] clarify purged http stats (#82123) 2022-01-04 09:51:41 -06:00
nodes-usage.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
pending.asciidoc Adding priority list and executing description to the pending tasks doc (#74456) (#78259) 2021-09-23 11:17:18 -04:00
remote-info.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
reroute.asciidoc [DOCS] Add security privileges to cluster API docs (#67589) 2021-01-19 10:18:59 -05:00
state.asciidoc Clarify cluster state API docs (#82930) 2022-01-24 10:09:45 -05:00
stats.asciidoc Add index pressure stats in cluster stats (#80303) 2021-12-09 12:41:08 +00:00
tasks.asciidoc Identify cancelled tasks in list tasks API (#72931) 2021-05-17 11:02:50 +01:00
update-settings.asciidoc [DOCS] Re-add cluster settings precedence (#82738) 2022-01-18 12:32:43 -05:00
voting-exclusions.asciidoc [DOCS] Fix double spaces (#71082) 2021-03-31 09:57:47 -04:00