1Search::Elasticsearch::UCsleirenCtoS:ne:ta8rr_ic0bh:u::t:DeEidlraePscettri:lc:sCDeaoatcr(uc3mh)e:n:tCaltiieonnt::8_0::Direct::Cat(3)
2
3
4

NAME

6       Search::Elasticsearch::Client::8_0::Direct::Cat - A client for running
7       cat debugging requests
8

VERSION

10       version 8.00
11

DESCRIPTION

13       The "cat" API in Elasticsearch provides information about your cluster
14       and indices in a simple, easy to read text format, intended for human
15       consumption.
16
17       These APIs have a number of parameters in common:
18
19       •   "help"
20
21           Returns help about the API, eg:
22
23               say $e->cat->allocation(help => 1);
24
25       •   "v"
26
27           Includes the column headers in the output:
28
29               say $e->cat->allocation(v => 1);
30
31       •   "h"
32
33           Accepts a list of column names to be output, eg:
34
35               say $e->cat->indices(h => ['health','index']);
36
37       •   "bytes"
38
39           Formats byte-based values as bytes ("b"), kilobytes ("k"),
40           megabytes ("m") or gigabytes ("g")
41
42       It does Search::Elasticsearch::Role::Client::Direct.
43

METHODS

45   help()
46           say $e->cat->help;
47
48       Returns the list of supported "cat" APIs
49
50   aliases()
51           say $e->cat->aliases(
52               name => 'name' | \@names    # optional
53           );
54
55       Returns information about index aliases, optionally limited to the
56       specified index/alias names.
57
58       Query string parameters:
59           "error_trace",
60           "format",
61           "h",
62           "help",
63           "human",
64           "local",
65           "master_timeout",
66           "s",
67           "v"
68
69       See the cat aliases docs
70       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
71       aliases.html> for more information.
72
73   allocation()
74           say $e->cat->allocation(
75               node_id => 'node' | \@nodes    # optional
76           );
77
78       Provides a snapshot of how shards have located around the cluster and
79       the state of disk usage.
80
81       Query string parameters:
82           "bytes",
83           "error_trace",
84           "format",
85           "h",
86           "help",
87           "human",
88           "local",
89           "master_timeout",
90           "s",
91           "v"
92
93       See the cat allocation docs
94       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
95       allocation.html> for more information.
96
97   count()
98           say $e->cat->count(
99               index => 'index' | \@indices    # optional
100           );
101
102       Provides quick access to the document count of the entire cluster, or
103       individual indices.
104
105       Query string parameters:
106           "error_trace",
107           "format",
108           "h",
109           "help",
110           "human",
111           "local",
112           "master_timeout",
113           "s",
114           "v"
115
116       See the cat count docs
117       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
118       count.html> for more information.
119
120   fielddata()
121           say $e->cat->fielddata(
122               fields => 'field' | \@fields    # optional
123           );
124
125       Shows the amount of memory used by each of the specified `fields` (or
126       all fields) loaded into fielddata.
127
128       Query string parameters:
129           "bytes",
130           "error_trace",
131           "format",
132           "h",
133           "help",
134           "human",
135           "local",
136           "master_timeout",
137           "s",
138           "v"
139
140       See the cat fielddata docs
141       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
142       fielddata.html> for more information.
143
144   health()
145           say $e->cat->health();
146
147       Provides a snapshot of how shards have located around the cluster and
148       the state of disk usage.
149
150       Query string parameters:
151           "error_trace",
152           "format",
153           "h",
154           "help",
155           "human",
156           "local",
157           "master_timeout",
158           "ts",
159           "s",
160           "v"
161
162       See the cat health docs
163       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
164       health.html> for more information.
165
166   indices()
167           say $e->cat->indices(
168               index => 'index' | \@indices    # optional
169           );
170
171       Provides a summary of index size and health for the whole cluster or
172       individual indices
173
174       Query string parameters:
175           "bytes",
176           "error_trace",
177           "format",
178           "h",
179           "health",
180           "help",
181           "human",
182           "local",
183           "master_timeout",
184           "pri",
185           "s",
186           "v"
187
188       See the cat indices docs
189       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
190       indices.html> for more information.
191
192   master()
193           say $e->cat->master();
194
195       Displays the master’s node ID, bound IP address, and node name.
196
197       Query string parameters:
198           "error_trace",
199           "format",
200           "h",
201           "help",
202           "human",
203           "local",
204           "master_timeout",
205           "s",
206           "v"
207
208       See the cat master docs
209       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
210       master.html> for more information.
211
212   nodeattrs()
213           say $e->cat->nodeattrs();
214
215       Returns the node attributes set per node.
216
217       Query string parameters:
218           "error_trace",
219           "format",
220           "h",
221           "help",
222           "human",
223           "local",
224           "master_timeout",
225           "s",
226           "v"
227
228       See the cat nodeattrs docs
229       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
230       nodeattrs.html> for more information.
231
232   nodes()
233           say $e->cat->nodes();
234
235       Provides a snapshot of all of the nodes in your cluster.
236
237       Query string parameters:
238           "error_trace",
239           "format",
240           "h",
241           "help",
242           "human",
243           "local",
244           "master_timeout",
245           "s",
246           "v"
247
248       See the cat nodes docs
249       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
250       nodes.html> for more information.
251
252   pending_tasks()
253           say $e->cat->pending_tasks();
254
255       Returns any cluster-level tasks which are queued on the master.
256
257       Query string parameters:
258           "error_trace",
259           "format",
260           "human",
261           "local",
262           "master_timeout",
263           "h",
264           "help",
265           "s",
266           "v"
267
268       See the cat pending-tasks docs
269       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
270       pending-tasks.html> for more information.
271
272   plugins()
273           say $e->cat->plugins();
274
275       Returns information about plugins installed on each node.
276
277       Query string parameters:
278           "error_trace",
279           "format",
280           "human",
281           "local",
282           "master_timeout",
283           "h",
284           "help",
285           "s",
286           "v"
287
288       See the cat plugins docs
289       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
290       plugins.html> for more information.
291
292   recovery()
293           say $e->cat->recovery(
294               index => 'index' | \@indices    # optional
295           );
296
297       Provides a view of shard replication. It will show information anytime
298       data from at least one shard is copying to a different node.  It can
299       also show up on cluster restarts. If your recovery process seems stuck,
300       try it to see if there’s any movement using recovery().
301
302       Query string parameters:
303           "bytes",
304           "error_trace",
305           "format",
306           "h",
307           "help",
308           "human",
309           "master_timeout",
310           "s",
311           "v"
312
313       See the cat recovery docs
314       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
315       recovery.html> for more information.
316
317   repositories()
318           say $e->cat->repositories()
319
320       Provides a list of registered snapshot repositories.
321
322       Query string parameters:
323           "error_trace",
324           "format",
325           "h",
326           "help",
327           "human",
328           "local",
329           "master_timeout",
330           "s",
331           "v"
332
333       See the cat repositories docs
334       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
335       repositories.html> for more information.
336
337   segments()
338           say $e->cat->segments(
339               index => 'index' | \@indices    # optional
340           );
341
342       Provides low level information about the segments in the shards of an
343       index.
344
345       Query string parameters:
346           "bytes",
347           "error_trace",
348           "format",
349           "h",
350           "help",
351           "human",
352           "s",
353           "v"
354
355       See the cat shards docs
356       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
357       segments.html> for more information.
358
359   shards()
360           say $e->cat->shards(
361               index => 'index' | \@indices    # optional
362           );
363
364       Provides a detailed view of what nodes contain which shards, the state
365       and size of each shard.
366
367       Query string parameters:
368           "bytes",
369           "error_trace",
370           "format",
371           "h",
372           "help",
373           "human",
374           "local",
375           "master_timeout",
376           "s",
377           "v"
378
379       See the cat shards docs
380       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
381       shards.html> for more information.
382
383   snapshots()
384           say $e->cat->snapshots(
385               repository => 'repository' | \@repositories # optional
386           )
387
388       Provides a list of all snapshots that belong to the specified
389       repositories.
390
391       Query string parameters:
392           "error_trace",
393           "format",
394           "h",
395           "help",
396           "human",
397           "ignore_unavailable",
398           "master_timeout",
399           "s",
400           "v"
401
402       See the cat snapshots docs
403       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
404       snapshots.html> for more information.
405
406   tasks()
407           say $e->cat->tasks()
408
409       Provides a list of node-level tasks.
410
411       Query string parameters:
412           "actions",
413           "detailed",
414           "error_trace",
415           "format",
416           "h",
417           "help",
418           "human",
419           "node_id",
420           "parent_node",
421           "parent_task",
422           "s",
423           "v"
424
425       See the cat tasks docs
426       <http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>
427       for more information.
428
429   templates()
430           say $e->cat->templates(
431               name => $name # optional
432           )
433
434       Provides a list of index templates.
435
436       Query string parameters:
437           "error_trace",
438           "format",
439           "h",
440           "help",
441           "human",
442           "local",
443           "master_timeout",
444           "s",
445           "v"
446
447       See the cat templates docs
448       <http://www.elastic.co/guide/en/elasticsearch/reference/current/templates.html>
449       for more information.
450
451   thread_pool()
452           say $e->cat->thread_pool(
453               index => 'index' | \@indices    # optional
454           );
455
456       Shows cluster wide thread pool statistics per node. By default the
457       "active", "queue" and "rejected" statistics are returned for the
458       "bulk", "index" and "search" thread pools.
459
460       Query string parameters:
461           "error_trace",
462           "format",
463           "h",
464           "help",
465           "human",
466           "local",
467           "master_timeout",
468           "size",
469           "s",
470           "v"
471
472       See the cat thread_pool docs
473       <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-
474       thread-pool.html> for more information.
475

AUTHOR

477       Enrico Zimuel <enrico.zimuel@elastic.co>
478
480       This software is Copyright (c) 2022 by Elasticsearch BV.
481
482       This is free software, licensed under:
483
484         The Apache License, Version 2.0, January 2004
485
486
487
488perl v5.38.0                Search2:0:2E3l-a0s7t-i2c1search::Client::8_0::Direct::Cat(3)
Impressum