Files
elasticsearch-js/docs/reference/api/NodesStatsRequest.md
2025-05-28 10:02:30 -05:00

2.4 KiB

NodesStatsRequest [interface-NodesStatsRequest]

Name Type Description
body string ({ [key: string]: any; } & { node_id?: never; metric?: never; index_metric?: never; completion_fields?: never; fielddata_fields?: never; fields?: never; groups?: never; include_segment_file_sizes?: never; level?: never; timeout?: never; types?: never; include_unloaded_segments?: never; })
completion_fields Fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
fielddata_fields Fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
fields Fields Comma-separated list or wildcard expressions of fields to include in the statistics.
groups boolean Comma-separated list of search groups to include in the search statistics.
include_segment_file_sizes boolean If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
include_unloaded_segments boolean If true, the response includes information from segments that are not loaded into memory.
index_metric Metrics Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
level Level Indicates whether statistics are aggregated at the cluster, index, or shard level.
metric Metrics Limit the information returned to the specified metrics
node_id NodeIds Comma-separated list of node IDs or names used to limit returned information.
querystring { [key: string]: any; } & { node_id?: never; metric?: never; index_metric?: never; completion_fields?: never; fielddata_fields?: never; fields?: never; groups?: never; include_segment_file_sizes?: never; level?: never; timeout?: never; types?: never; include_unloaded_segments?: never; } All values in querystring will be added to the request querystring.
timeout Duration Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
types string[] A comma-separated list of document types for the indexing index metric.