Files
OpenSearch-Docs-Cn/_api-reference/cat/cat-allocation.md
T

66 lines
1.9 KiB
Markdown
Raw Normal View History

2021-06-21 23:13:40 -07:00
---
layout: default
title: CAT allocation
parent: CAT API
2023-05-04 11:22:52 -07:00
redirect_from:
- /opensearch/rest-api/cat/cat-allocation/
2021-06-21 23:13:40 -07:00
nav_order: 5
has_children: false
---
# CAT allocation
**Introduced 1.0**
2021-07-26 16:14:22 -07:00
{: .label .label-purple }
2021-06-21 23:13:40 -07:00
2023-05-04 11:22:52 -07:00
The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.
2021-06-21 23:13:40 -07:00
## Example
```json
GET _cat/allocation?v
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
To limit the information to a specific node, add the node name after your query:
```json
GET _cat/allocation/<node_name>
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
If you want to get information for more than one node, separate the node names with commas:
```json
GET _cat/allocation/node_name_1,node_name_2,node_name_3
2021-06-21 23:13:40 -07:00
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
## Path and HTTP methods
```
GET _cat/allocation?v
GET _cat/allocation/<node_name>
```
## URL parameters
All CAT allocation URL parameters are optional.
2021-06-21 23:13:40 -07:00
2022-10-27 11:50:39 -05:00
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
2021-06-21 23:13:40 -07:00
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
2022-12-06 14:52:33 -07:00
local | Boolean | Whether to return information from the local node only instead of from the cluster_manager 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.
2021-06-21 23:13:40 -07:00
## Response
2023-05-04 11:22:52 -07:00
The following response shows that eight shards are allocated to each of the two nodes available:
2021-06-21 23:13:40 -07:00
```json
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
```