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

› ›

cat.shards

edit

cat.shards

edit

client.cat.shards({
  index: 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

`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
`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.segments cat.snapshots »