Get shard allocation information

GET /_cat/allocation/{node_id}
GET /_cat/allocation

Get a snapshot of the number of shards allocated to each data node and their disk space.

Important

CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

h union oneOf

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

shards (or s): The number of shards on the node.
shards.undesired: The number of shards scheduled to be moved elsewhere in the cluster.
write_load.forecast (or wlf, writeLoadForecast): The sum of index write load forecasts.
disk.indices.forecast (or dif, diskIndicesForecast): The sum of shard size forecasts.
disk.indices (or di, diskIndices): The disk space used by Elasticsearch indices.
disk.used (or du, diskUsed): The total disk space used on the node.
disk.avail (or da, diskAvail): The available disk space on the node.
disk.total (or dt, diskTotal): The total disk capacity of all volumes on the node.
disk.percent (or dp, diskPercent): The percentage of disk space used on the node.
host (or h): IThe host of the node.
ip: The IP address of the node.
node (or n): The name of the node.
node.role (or r, role, nodeRole): The roles assigned to the node.

Values: shards s shards.undesired write_load.forecast wlf writeLoadForecast disk.indices.forecast dif diskIndicesForecast disk.indices di diskIndices disk.used du diskUsed disk.avail da diskAvail disk.total dt diskTotal disk.percent dp diskPercent host h ip node n node.role r role nodeRole

s union oneOf

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

One of: string[] or string

local boolean · default: false

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

master_timeout string · default: 30s

Period to wait for a connection to the master node.

format string · default: text

Specifies the format to return the columnar data in, can be set to text, json, cbor, yaml, or smile.

help boolean · default: false

When set to true will output available columns. This option can't be combined with any other query string option.

v boolean · default: false

When set to true will enable verbose output.

bytes enum

Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance 1kb means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as kb, mb, or gb, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down.

Values: b kb mb gb tb pb

time enum

Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as ms, s, m or h, chosen such that the numeric value of the column is as small as possible whilst still being at least 1.0. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down.

Values: nanos micros ms s m h d

Response

application/json

<array> object[]

Get shard allocation information

Required authorization

Authentication

Path parameters

Query parameters

Response