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

« nodes.reloadSecureSettings nodes.usage »

› ›

nodes.stats

edit

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

nodes.stats

edit

client.nodes.stats({
  metric: string | string[],
  index_metric: string | string[],
  node_id: string | string[],
  completion_fields: string | string[],
  fielddata_fields: string | string[],
  fields: string | string[],
  groups: boolean,
  level: 'indices' | 'node' | 'shards',
  types: string | string[],
  timeout: string,
  include_segment_file_sizes: boolean
})

Reference

`metric`	`string \| string[]` - Limit the information returned to the specified metrics
`index_metric` or `indexMetric`	`string \| string[]` - Limit the information returned for `indices` metric to the specific index metrics. Isn’t used if `indices` (or `all`) metric isn’t specified.
`node_id` or `nodeId`	`string \| string[]` - A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you’re connecting to, leave empty to get information from all nodes
`completion_fields` or `completionFields`	`string \| string[]` - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
`fielddata_fields` or `fielddataFields`	`string \| string[]` - A comma-separated list of fields for `fielddata` index metric (supports wildcards)
`fields`	`string \| string[]` - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
`groups`	`boolean` - A comma-separated list of search groups for `search` index metric
`level`	`'indices' \| 'node' \| 'shards'` - Return indices stats aggregated at index, node or shard level Default: `node`
`types`	`string \| string[]` - A comma-separated list of document types for the `indexing` index metric
`timeout`	`string` - Explicit operation timeout
`include_segment_file_sizes` or `includeSegmentFileSizes`	`boolean` - Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)

« nodes.reloadSecureSettings nodes.usage »