mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn synced 2025-03-09 14:38:01 +00:00

add operation to titles to differentiate from the API group acronym (#1750 )

* add operation to titles to differentiate from the API group acronym

Signed-off-by: alicejw <alicejw@amazon.com>

* update frontmatter with new page title

Signed-off-by: alicejw <alicejw@amazon.com>

* for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713

Signed-off-by: alicejw <alicejw@amazon.com>

* to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly

Signed-off-by: alicejw <alicejw@amazon.com>

* to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>

2022-10-31 09:21:32 -07:00

1.8 KiB

Raw Blame History

layout	title	parent	nav_order	has_children
default	CAT allocation	CAT API	5	false

CAT allocation

Introduced 1.0 {: .label .label-purple }

The CAT allocation operation lists the allocation of disk space for indices and the number of shards on each node.

Example

GET _cat/allocation?v

To limit the information to a specific node, add the node name after your query:

GET _cat/allocation/<node_name>

If you want to get information for more than one node, separate the node names with commas:

GET _cat/aliases/node_name_1,node_name_2,node_name_3

Path and HTTP methods

GET _cat/allocation?v
GET _cat/allocation/<node_name>

URL parameters

All CAT allocation URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

Parameter	Type	Description
bytes	Byte size	Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see Supported units.
local	Boolean	Whether to return information from the local node only instead of from the master node. Default is false.
cluster_manager_timeout	Time	The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

Response

The following response shows that 8 shards are allocated to each the two nodes available:

shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip          | node
  8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.4   | 172.18.0.4  | odfe-node1
  8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.3   | 172.18.0.3  | odfe-node2

1.8 KiB Raw Blame History