[DOCS] Reformats cat allocation API (#45158)

This commit is contained in:
James Rodewig 2019-08-05 11:17:37 -04:00
parent f3570aa27b
commit adaa54c066
2 changed files with 48 additions and 6 deletions

View File

@ -1,8 +1,41 @@
[[cat-allocation]]
=== cat allocation
`allocation` provides a snapshot of how many shards are allocated to each data node
and how much disk space they are using.
Provides a snapshot of the number of shards allocated to each data node
and their disk space.
[[cat-allocation-api-request]]
==== {api-request-title}
`GET /_cat/allocation/{node_id}`
[[cat-allocation-api-path-params]]
==== {api-path-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=node-id]
[[cat-allocation-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-allocation-api-example]]
==== {api-examples-title}
[source,js]
--------------------------------------------------
@ -11,7 +44,7 @@ GET /_cat/allocation?v
// CONSOLE
// TEST[s/^/PUT test\n{"settings": {"number_of_replicas": 0}}\n/]
Might respond with:
The API returns the following response:
[source,txt]
--------------------------------------------------
@ -21,6 +54,4 @@ shards disk.indices disk.used disk.avail disk.total disk.percent host ip
// TESTRESPONSE[s/\d+(\.\d+)?[tgmk]?b/\\d+(\\.\\d+)?[tgmk]?b/ s/46/\\d+/]
// TESTRESPONSE[s/CSUXak2/.+/ non_json]
Here we can see that the single shard created has been allocated to the single
node available.
This response shows a single shard is allocated to the one node available.

View File

@ -1,4 +1,9 @@
tag::bytes[]
`bytes`::
(Optional, <<byte-units,byte size units>>) Unit used to display byte values.
end::bytes[]
tag::cat-h[]
`h` (headings)::
(Optional, string) Comma-separated list of column names to display.
@ -29,6 +34,12 @@ tag::name[]
(Optional, string) Comma-separated list of alias names to return.
end::name[]
tag::node-id[]
`{node_id}`::
(Optional, string) Comma-separated list of node IDs or names used to limit
returned information.
end::node-id[]
tag::cat-s[]
`s` (sort)::
(Optional, string) Comma-separated list of column names or column aliases used