elasticsearch/_async/client/nodes.py [357:473]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
index_metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
completion_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
error_trace: t.Optional[bool] = None,
fielddata_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
groups: t.Optional[bool] = None,
human: t.Optional[bool] = None,
include_segment_file_sizes: t.Optional[bool] = None,
include_unloaded_segments: t.Optional[bool] = None,
level: t.Optional[
t.Union[str, t.Literal["cluster", "indices", "shards"]]
] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
types: t.Optional[t.Sequence[str]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Get node statistics.
Get statistics for nodes in a cluster.
By default, all stats are returned. You can limit the returned information by using metrics.
``_
:param node_id: Comma-separated list of node IDs or names used to limit returned
information.
:param metric: Limit the information returned to the specified metrics
:param index_metric: Limit the information returned for indices metric to the
specific index metrics. It can be used only if indices (or all) metric is
specified.
:param completion_fields: Comma-separated list or wildcard expressions of fields
to include in fielddata and suggest statistics.
:param fielddata_fields: Comma-separated list or wildcard expressions of fields
to include in fielddata statistics.
:param fields: Comma-separated list or wildcard expressions of fields to include
in the statistics.
:param groups: Comma-separated list of search groups to include in the search
statistics.
:param include_segment_file_sizes: If true, the call reports the aggregated disk
usage of each one of the Lucene index files (only applies if segment stats
are requested).
:param include_unloaded_segments: If `true`, the response includes information
from segments that are not loaded into memory.
:param level: Indicates whether statistics are aggregated at the cluster, index,
or shard level.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
:param types: A comma-separated list of document types for the indexing index
metric.
"""
__path_parts: t.Dict[str, str]
if (
node_id not in SKIP_IN_PATH
and metric not in SKIP_IN_PATH
and index_metric not in SKIP_IN_PATH
):
__path_parts = {
"node_id": _quote(node_id),
"metric": _quote(metric),
"index_metric": _quote(index_metric),
}
__path = f'/_nodes/{__path_parts["node_id"]}/stats/{__path_parts["metric"]}/{__path_parts["index_metric"]}'
elif node_id not in SKIP_IN_PATH and metric not in SKIP_IN_PATH:
__path_parts = {"node_id": _quote(node_id), "metric": _quote(metric)}
__path = f'/_nodes/{__path_parts["node_id"]}/stats/{__path_parts["metric"]}'
elif metric not in SKIP_IN_PATH and index_metric not in SKIP_IN_PATH:
__path_parts = {
"metric": _quote(metric),
"index_metric": _quote(index_metric),
}
__path = (
f'/_nodes/stats/{__path_parts["metric"]}/{__path_parts["index_metric"]}'
)
elif node_id not in SKIP_IN_PATH:
__path_parts = {"node_id": _quote(node_id)}
__path = f'/_nodes/{__path_parts["node_id"]}/stats'
elif metric not in SKIP_IN_PATH:
__path_parts = {"metric": _quote(metric)}
__path = f'/_nodes/stats/{__path_parts["metric"]}'
else:
__path_parts = {}
__path = "/_nodes/stats"
__query: t.Dict[str, t.Any] = {}
if completion_fields is not None:
__query["completion_fields"] = completion_fields
if error_trace is not None:
__query["error_trace"] = error_trace
if fielddata_fields is not None:
__query["fielddata_fields"] = fielddata_fields
if fields is not None:
__query["fields"] = fields
if filter_path is not None:
__query["filter_path"] = filter_path
if groups is not None:
__query["groups"] = groups
if human is not None:
__query["human"] = human
if include_segment_file_sizes is not None:
__query["include_segment_file_sizes"] = include_segment_file_sizes
if include_unloaded_segments is not None:
__query["include_unloaded_segments"] = include_unloaded_segments
if level is not None:
__query["level"] = level
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
if types is not None:
__query["types"] = types
__headers = {"accept": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
elasticsearch/_sync/client/nodes.py [357:473]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
self,
*,
node_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
index_metric: t.Optional[t.Union[str, t.Sequence[str]]] = None,
completion_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
error_trace: t.Optional[bool] = None,
fielddata_fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
fields: t.Optional[t.Union[str, t.Sequence[str]]] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
groups: t.Optional[bool] = None,
human: t.Optional[bool] = None,
include_segment_file_sizes: t.Optional[bool] = None,
include_unloaded_segments: t.Optional[bool] = None,
level: t.Optional[
t.Union[str, t.Literal["cluster", "indices", "shards"]]
] = None,
pretty: t.Optional[bool] = None,
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
types: t.Optional[t.Sequence[str]] = None,
) -> ObjectApiResponse[t.Any]:
"""
.. raw:: html
Get node statistics.
Get statistics for nodes in a cluster.
By default, all stats are returned. You can limit the returned information by using metrics.
``_
:param node_id: Comma-separated list of node IDs or names used to limit returned
information.
:param metric: Limit the information returned to the specified metrics
:param index_metric: Limit the information returned for indices metric to the
specific index metrics. It can be used only if indices (or all) metric is
specified.
:param completion_fields: Comma-separated list or wildcard expressions of fields
to include in fielddata and suggest statistics.
:param fielddata_fields: Comma-separated list or wildcard expressions of fields
to include in fielddata statistics.
:param fields: Comma-separated list or wildcard expressions of fields to include
in the statistics.
:param groups: Comma-separated list of search groups to include in the search
statistics.
:param include_segment_file_sizes: If true, the call reports the aggregated disk
usage of each one of the Lucene index files (only applies if segment stats
are requested).
:param include_unloaded_segments: If `true`, the response includes information
from segments that are not loaded into memory.
:param level: Indicates whether statistics are aggregated at the cluster, index,
or shard level.
:param timeout: Period to wait for a response. If no response is received before
the timeout expires, the request fails and returns an error.
:param types: A comma-separated list of document types for the indexing index
metric.
"""
__path_parts: t.Dict[str, str]
if (
node_id not in SKIP_IN_PATH
and metric not in SKIP_IN_PATH
and index_metric not in SKIP_IN_PATH
):
__path_parts = {
"node_id": _quote(node_id),
"metric": _quote(metric),
"index_metric": _quote(index_metric),
}
__path = f'/_nodes/{__path_parts["node_id"]}/stats/{__path_parts["metric"]}/{__path_parts["index_metric"]}'
elif node_id not in SKIP_IN_PATH and metric not in SKIP_IN_PATH:
__path_parts = {"node_id": _quote(node_id), "metric": _quote(metric)}
__path = f'/_nodes/{__path_parts["node_id"]}/stats/{__path_parts["metric"]}'
elif metric not in SKIP_IN_PATH and index_metric not in SKIP_IN_PATH:
__path_parts = {
"metric": _quote(metric),
"index_metric": _quote(index_metric),
}
__path = (
f'/_nodes/stats/{__path_parts["metric"]}/{__path_parts["index_metric"]}'
)
elif node_id not in SKIP_IN_PATH:
__path_parts = {"node_id": _quote(node_id)}
__path = f'/_nodes/{__path_parts["node_id"]}/stats'
elif metric not in SKIP_IN_PATH:
__path_parts = {"metric": _quote(metric)}
__path = f'/_nodes/stats/{__path_parts["metric"]}'
else:
__path_parts = {}
__path = "/_nodes/stats"
__query: t.Dict[str, t.Any] = {}
if completion_fields is not None:
__query["completion_fields"] = completion_fields
if error_trace is not None:
__query["error_trace"] = error_trace
if fielddata_fields is not None:
__query["fielddata_fields"] = fielddata_fields
if fields is not None:
__query["fields"] = fields
if filter_path is not None:
__query["filter_path"] = filter_path
if groups is not None:
__query["groups"] = groups
if human is not None:
__query["human"] = human
if include_segment_file_sizes is not None:
__query["include_segment_file_sizes"] = include_segment_file_sizes
if include_unloaded_segments is not None:
__query["include_unloaded_segments"] = include_unloaded_segments
if level is not None:
__query["level"] = level
if pretty is not None:
__query["pretty"] = pretty
if timeout is not None:
__query["timeout"] = timeout
if types is not None:
__query["types"] = types
__headers = {"accept": "application/json"}
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -