1
2
3[[Elasticsearch_Namespaces_NodesNamespace]]
4=== Elasticsearch\Namespaces\NodesNamespace
5
6
7
8Class NodesNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_NodesNamespacehotThreads_hotThreads,`hotThreads()`>>
22* <<Elasticsearch_Namespaces_NodesNamespaceinfo_info,`info()`>>
23* <<Elasticsearch_Namespaces_NodesNamespacereloadSecureSettings_reloadSecureSettings,`reloadSecureSettings()`>>
24* <<Elasticsearch_Namespaces_NodesNamespacestats_stats,`stats()`>>
25* <<Elasticsearch_Namespaces_NodesNamespaceusage_usage,`usage()`>>
26
27
28
29[[Elasticsearch_Namespaces_NodesNamespacehotThreads_hotThreads]]
30.`hotThreads(array $params = [])`
31****
32[source,php]
33----
34/*
35$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
36$params['interval']            = (time) The interval for the second sampling of threads
37$params['snapshots']           = (number) Number of samples of thread stacktrace (default: 10)
38$params['threads']             = (number) Specify the number of threads to provide information for (default: 3)
39$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)
40$params['type']                = (enum) The type to sample (default: cpu) (Options = cpu,wait,block)
41$params['timeout']             = (time) Explicit operation timeout
42*/
43----
44****
45
46
47
48[[Elasticsearch_Namespaces_NodesNamespaceinfo_info]]
49.`info(array $params = [])`
50****
51[source,php]
52----
53/*
54$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
55$params['metric']        = (list) A comma-separated list of metrics you wish returned. Leave empty to return all.
56*/
57----
58****
59
60
61
62[[Elasticsearch_Namespaces_NodesNamespacereloadSecureSettings_reloadSecureSettings]]
63.`reloadSecureSettings(array $params = [])`
64****
65[source,php]
66----
67/*
68$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.
69*/
70----
71****
72
73
74
75[[Elasticsearch_Namespaces_NodesNamespacestats_stats]]
76.`stats(array $params = [])`
77****
78[source,php]
79----
80/*
81$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
82$params['metric']                     = (list) Limit the information returned to the specified metrics
83$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.
84*/
85----
86****
87
88
89
90[[Elasticsearch_Namespaces_NodesNamespaceusage_usage]]
91.`usage(array $params = [])`
92****
93[source,php]
94----
95/*
96$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
97$params['metric']  = (list) Limit the information returned to the specified metrics
98$params['timeout'] = (time) Explicit operation timeout
99*/
100----
101****
102
103
104