[DOCS] Reformats cluster stats API and expands common params (#45270)

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
This commit is contained in:
István Zoltán Szabó 2019-08-07 16:46:39 +02:00
parent c7ec0b8431
commit 95d3a8e8ad
2 changed files with 45 additions and 5 deletions

View File

@ -1,10 +1,43 @@
[[cluster-stats]] [[cluster-stats]]
=== Cluster Stats === Cluster Stats
The Cluster Stats API allows to retrieve statistics from a cluster wide perspective. Returns cluster statistics.
The API returns basic index metrics (shard numbers, store size, memory usage) and
information about the current nodes that form the cluster (number, roles, os, jvm
versions, memory usage, cpu and installed plugins). [[cluster-stats-api-request]]
==== {api-request-title}
`GET /_cluster/stats` +
`GET /_cluster/stats/nodes/{node_id}`
[[cluster-stats-api-desc]]
==== {api-description-title}
The Cluster Stats API allows to retrieve statistics from a cluster wide
perspective. The API returns basic index metrics (shard numbers, store size,
memory usage) and information about the current nodes that form the cluster
(number, roles, os, jvm versions, memory usage, cpu and installed plugins).
[[cluster-stats-api-path-params]]
==== {api-path-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cluster-stats-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
[[cluster-stats-api-example]]
==== {api-examples-title}
[source,js] [source,js]
-------------------------------------------------- --------------------------------------------------
@ -13,7 +46,8 @@ GET /_cluster/stats?human&pretty
// CONSOLE // CONSOLE
// TEST[setup:twitter] // TEST[setup:twitter]
Will return, for example: The API returns the following response:
["source","js",subs="attributes,callouts"] ["source","js",subs="attributes,callouts"]
-------------------------------------------------- --------------------------------------------------
{ {

View File

@ -9,6 +9,12 @@ tag::cat-h[]
(Optional, string) Comma-separated list of column names to display. (Optional, string) Comma-separated list of column names to display.
end::cat-h[] end::cat-h[]
tag::flat-settings[]
`flat_settings`::
(Optional, boolean) If `true`, returns settings in flat format. Defaults to
`false`.
end::flat-settings[]
tag::help[] tag::help[]
`help`:: `help`::
(Optional, boolean) If `true`, the response returns help information. Defaults (Optional, boolean) If `true`, the response returns help information. Defaults