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.help cat.master »
Elastic Docs ›elasticsearch.js ›7.3 API

cat.indices

edit

cat.indices

edit
client.cat.indices([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"
  • "m"
  • "g"

local

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

masterTimeout

DurationString — Explicit operation timeout for connection to master node

h

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

health

String — A health status ("green", "yellow", or "red" to filter only indices matching the specified health status

Options
  • "green"
  • "yellow"
  • "red"

help

Boolean — Return help information

pri

Boolean — Set to true to return stats only for primary shards

s

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

time

String — The unit in which to display time values

Options
  • "d (Days)"
  • "h (Hours)"
  • "m (Minutes)"
  • "s (Seconds)"
  • "ms (Milliseconds)"
  • "micros (Microseconds)"
  • "nanos (Nanoseconds)"

v

Boolean — Verbose mode. Display column headers

includeUnloadedSegments

Boolean — If set to true segment stats will include stats for segments that are not currently loaded into memory

index

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

back to top

« cat.help cat.master »