WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« cat.repositories cat.shards »
Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference

cat.segments

edit

cat.segments

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

Reference

index

string | string[] - A comma-separated list of index 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

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.repositories cat.shards »