Namespace: API-Nodes

API-Nodes

Source:

Methods

(static) NodesApi#hotThreads(params, options, callback) → {Object|Promise.<never>|*}

Returns information about hot threads on each node in the cluster.
See Also: OpenSearch - Nodes Hot Threads
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
node_id string <optional>
 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
interval string <optional>
 The interval for the second sampling of threads
snapshots number <optional>
 Number of samples of thread stacktrace (default: 10)
threads number <optional>
 Specify the number of threads to provide information for (default: 3)
ignore_idle_threads boolean <optional>
 Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)
type string <optional>
 The type to sample (default: cpu) (options: cpu, wait, block)
timeout string <optional>
 Explicit operation timeout
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) NodesApi#info(params, options, callback) → {Object|Promise.<never>|*}

Returns information about hot threads on each node in the cluster.
See Also: OpenSearch - Nodes Info
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
node_id string <optional>
 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
metric string <optional>
 A comma-separated list of metrics you wish returned. Leave empty to return all. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest)
flat_settings boolean <optional>
 Return settings in flat format (default: false)
timeout string <optional>
 Explicit operation timeout
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) NodesApi#reloadSecureSettings(params, options, callback) → {Object|Promise.<never>|*}

Reloads secure settings.
See Also: OpenSearch - Nodes Reload Security Settings
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
node_id string <optional>
 A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
timeout string <optional>
 Explicit operation timeout
body Object <optional>
 An object containing the password for the opensearch keystore
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) NodesApi#stats(params, options, callback) → {Object|Promise.<never>|*}

Returns statistical information about nodes in the cluster.
See Also: OpenSearch - Nodes Stats
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
node_id string <optional>
 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
metric string <optional>
 Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure)
index_metric string <optional>
 Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, suggest)
completion_fields string <optional>
 A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
fielddata_fields string <optional>
 A comma-separated list of fields for `fielddata` index metric (supports wildcards)
fields string <optional>
 A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
groups boolean <optional>
 A comma-separated list of search groups for `search` index metric
level string <optional>
 Return indices stats aggregated at index, node or shard level (options: indices, node, shards)
types string <optional>
 A comma-separated list of document types for the `indexing` index metric
timeout string <optional>
 Explicit operation timeout
include_segment_file_sizes boolean <optional>
 Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)
include_unloaded_segments boolean <optional>
 If set to true segment stats will include stats for segments that are not currently loaded into memory
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *

(static) NodesApi#usage(params, options, callback) → {Object|Promise.<never>|*}

Returns low-level information about REST actions usage on nodes.
See Also: OpenSearch - Nodes Usage
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
node_id string <optional>
 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
metric string <optional>
 Limit the information returned to the specified metrics (options: _all, rest_actions)
timeout string <optional>
 Explicit operation timeout
options Object Options for Transport#request
callback function Callback that handles errors and response
Source:
Returns:
Type
Object | Promise.<never> | *