Get shard allocation information | Elasticsearch API documentation

Get shard allocation information Generally available

GET /_cat/allocation/{node_id}

All methods and paths for this operation:

GET /_cat/allocation

GET /_cat/allocation/{node_id}

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.

Required authorization

Cluster privileges: monitor

Path parameters

node_id string | array[string] Required

A comma-separated list of node identifiers or names used to limit the returned information.

Query parameters

h string | array[string]
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 are 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, or nodeRole.
s string | array[string]

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.
local boolean

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.

Default value is false.
master_timeout string

Period to wait for a connection to the master node.

Default value is 30s.
format string

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

Default value is text.
help boolean

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

Default value is false.
v boolean

When set to true will enable verbose output.

Default value is false.
bytes string

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 are b, kb, mb, gb, tb, or pb.
time string

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 are nanos, micros, ms, s, m, h, or d.

Responses

200 application/json
Hide response attributes Show response attributes object
- shards string
  
  Number of primary and replica shards assigned to the node.
- shards.undesired string | null
  Amount of shards that are scheduled to be moved elsewhere in the cluster or -1 other than desired balance allocator is used
  
  One of:
  string-1 string string-2 string | null
- write_load.forecast number | string | null
  Sum of index write load forecasts
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.indices.forecast number | string | null
  Sum of shard size forecasts
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.indices number | string | null
  Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.used number | string | null
  Total disk space in use. Elasticsearch retrieves this metric from the node’s operating system (OS). The metric includes disk space for: Elasticsearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. Unlike disk.indices, this metric does not double-count disk space for hard-linked files.
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.avail number | string | null
  Free disk space available to Elasticsearch. Elasticsearch retrieves this metric from the node’s operating system. Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.total number | string | null
  Total disk space for the node, including in-use and available space.
  
  One of:
  number-1 number string-2 string string-2 string | null
- disk.percent string | number | null
  Total percentage of disk space in use. Calculated as disk.used / disk.total.
  
  One of:
  string-1 string number-2 number string-2 string | null
- host string | null
  Network host for the node. Set using the network.host setting.
  
  One of:
  Host string string-2 string | null
- ip string | null
  IP address and port for the node.
  
  One of:
  Ip string string-2 string | null
- node string
  
  Name for the node. Set using the node.name setting.
- node.role string | null
  Node roles
  
  One of:
  string-1 string string-2 string | null

GET /_cat/allocation/{node_id}

GET /_cat/allocation?v=true&format=json

resp = client.cat.allocation(
    v=True,
    format="json",
)

const response = await client.cat.allocation({
  v: "true",
  format: "json",
});

response = client.cat.allocation(
  v: "true",
  format: "json"
)

$resp = $client->cat()->allocation([
    "v" => "true",
    "format" => "json",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_cat/allocation?v=true&format=json"

client.cat().allocation(a -> a);

Response examples (200)

A successful response from `GET /_cat/allocation?v=true&format=json`. It shows a single shard is allocated to the one node available.

[
  {
    "shards": "1",
    "shards.undesired": "0",
    "write_load.forecast": "0.0",
    "disk.indices.forecast": "260b",
    "disk.indices": "260b",
    "disk.used": "47.3gb",
    "disk.avail": "43.4gb",
    "disk.total": "100.7gb",
    "disk.percent": "46",
    "host": "127.0.0.1",
    "ip": "127.0.0.1",
    "node": "CSUXak2",
    "node.role": "himrst"
  }
]