New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\Namespaces\MonitoringNamespace Elasticsearch\Namespaces\RollupNamespace »
Elastic Docs ›Elasticsearch PHP Client [7.17] ›Reference - Endpoints

Elasticsearch\Namespaces\NodesNamespace

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

Elasticsearch\Namespaces\NodesNamespace

edit

Class NodesNamespace

Description

this file is autogenerated using util/GenerateEndpoints.php and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)

Methods

The class defines the following methods:

hotThreads(array $params = [])

/*
$params['node_id']             = (list) 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
$params['interval']            = (time) The interval for the second sampling of threads
$params['snapshots']           = (number) Number of samples of thread stacktrace (default: 10)
$params['threads']             = (number) Specify the number of threads to provide information for (default: 3)
$params['ignore_idle_threads'] = (boolean) 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)
$params['type']                = (enum) The type to sample (default: cpu) (Options = cpu,wait,block)
$params['timeout']             = (time) Explicit operation timeout
*/

info(array $params = [])

/*
$params['node_id']       = (list) 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
$params['metric']        = (list) A comma-separated list of metrics you wish returned. Leave empty to return all.
*/

reloadSecureSettings(array $params = [])

/*
$params['node_id'] = (list) A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.
*/

stats(array $params = [])

/*
$params['node_id']                    = (list) 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
$params['metric']                     = (list) Limit the information returned to the specified metrics
$params['index_metric']               = (list) Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.
*/

usage(array $params = [])

/*
$params['node_id'] = (list) 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
$params['metric']  = (list) Limit the information returned to the specified metrics
$params['timeout'] = (time) Explicit operation timeout
*/
« Elasticsearch\Namespaces\MonitoringNamespace Elasticsearch\Namespaces\RollupNamespace »
Was this helpful?
Feedback