IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cat.repositories cat.shards »
Elastic Docs ›elasticsearch.js ›6.8 API

cat.segments

edit

cat.segments

edit
client.cat.segments([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

format

String — a short version of the Accept header, e.g. json, yaml

bytes

String — The unit in which to display byte values

Options
  • "b"
  • "k"
  • "kb"
  • "m"
  • "mb"
  • "g"
  • "gb"
  • "t"
  • "tb"
  • "p"
  • "pb"

h

String, String[], Boolean — Comma-separated list of column names to display

help

Boolean — Return help information

s

String, String[], Boolean — Comma-separated list of column names or column aliases to sort by

v

Boolean — Verbose mode. Display column headers

index

String, String[], Boolean — A comma-separated list of index names to limit the returned information

back to top

« cat.repositories cat.shards »