62 lines
4.0 KiB
Plaintext
62 lines
4.0 KiB
Plaintext
[[reference-cat-allocation]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
=== client.cat.allocation
|
|
|
|
Provides 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.
|
|
|
|
{ref}/cat-allocation.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(CatAllocationRequest, options?): Promise<CatAllocationResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `CatAllocationRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface CatAllocationRequest extends CatCatRequestBase {
|
|
node_id?: <<shared-type-node-ids, NodeIds>>
|
|
bytes?: <<shared-type-bytes, Bytes>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `CatAllocationResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type CatAllocationResponse = CatAllocationAllocationRecord[]
|
|
----
|
|
|