NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« cat.aliases cat.count »
Elastic Docs ›Elasticsearch Node.js client [6.x] ›API Reference

cat.allocation

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

cat.allocation

edit
client.cat.allocation({
  node_id: string | string[],
  format: string,
  bytes: 'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb',
  local: boolean,
  master_timeout: string,
  h: string | string[],
  help: boolean,
  s: string | string[],
  v: boolean
})

Reference

node_id or nodeId

string | string[] - A comma-separated list of node IDs or names to limit the returned information

format

string - a short version of the Accept header, e.g. json, yaml

bytes

'b' | 'k' | 'kb' | 'm' | 'mb' | 'g' | 'gb' | 't' | 'tb' | 'p' | 'pb' - The unit in which to display byte values

local

boolean - Return local information, do not retrieve the state from master node (default: false)

master_timeout or masterTimeout

string - Explicit operation timeout for connection to master node

h

string | string[] - Comma-separated list of column names to display

help

boolean - Return help information

s

string | string[] - Comma-separated list of column names or column aliases to sort by

v

boolean - Verbose mode. Display column headers
« cat.aliases cat.count »