GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SEARCH::ELASTICSEARCH::CLIENT::1_0::DIRECT::CAT (3)

.ds Aq ’

NAME

Search::Elasticsearch::Client::1_0::Direct::Cat - A client for running cat debugging requests

CONTENTS

VERSION

version 2.00

DESCRIPTION

The cat API in Elasticsearch provides information about your cluster and indices in a simple, easy to read text format, intended for human consumption.

These APIs have a number of parameters in common:
o help

Returns help about the API, eg:



    say $e->cat->allocation(help => 1);



o v

Includes the column headers in the output:



    say $e->cat->allocation(v => 1);



o h

Accepts a list of column names to be output, eg:



    say $e->cat->indices(h => [health,index]);



o bytes

Formats byte-based values as bytes (b), kilobytes (k), megabytes (m) or gigabytes (g)

It does Search::Elasticsearch::Role::Client::Direct.

METHODS

CWhelp()



    say $e->cat->help;



Returns the list of supported cat APIs

CWaliases()



    say $e->cat->aliases(
        name => name | \@names    # optional
    );



Returns information about index aliases, optionally limited to the specified index/alias names.

Query string parameters:
h,
help,
local,
master_timeout,
v

See the cat aliases docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-aliases.html> for more information.

CWallocation()



    say $e->cat->allocation(
        node_id => node | \@nodes    # optional
    );



Provides a snapshot of how shards have located around the cluster and the state of disk usage.

Query string parameters:
bytes,
h,
help,
local,
master_timeout,
v

See the cat allocation docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html> for more information.

CWcount()



    say $e->cat->count(
        index => index | \@indices    # optional
    );



Provides quick access to the document count of the entire cluster, or individual indices.

Query string parameters:
h,
help,
local,
master_timeout,
v

See the cat count docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html> for more information.

CWfielddata()



    say $e->cat->fielddata(
        fields => field | \@fields    # optional
    );



Shows the amount of memory used by each of the specified ‘fields‘ (or all fields) loaded into fielddata.

Query string parameters:
bytes,
h,
help,
local,
master_timeout,
v

See the cat fielddata docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html> for more information.

CWhealth()



    say $e->cat->health();



Provides a snapshot of how shards have located around the cluster and the state of disk usage.

Query string parameters:
bytes,
h,
help,
local,
master_timeout,
ts,
v

See the cat health docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html> for more information.

CWindices()



    say $e->cat->indices(
        index => index | \@indices    # optional
    );



Provides a summary of index size and health for the whole cluster or individual indices

Query string parameters:
bytes,
h,
help,
local,
master_timeout,
pri,
v

See the cat indices docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html> for more information.

CWmaster()



    say $e->cat->master();



Displays the masterXs node ID, bound IP address, and node name.

Query string parameters:
h,
help,
local,
master_timeout,
v

See the cat master docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html> for more information.

CWnodes()



    say $e->cat->nodes();



Provides a snapshot of all of the nodes in your cluster.

Query string parameters:
h,
help,
local,
master_timeout,
v

See the cat nodes docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html> for more information.

CWpending_tasks()



    say $e->cat->pending_tasks();



Returns any cluster-level tasks which are queued on the master.

Query string parameters:
local,
master_timeout,
h,
help,
v

See the cat pending-tasks docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html> for more information.

CWplugins()



    say $e->cat->plugins();



Returns information about plugins installed on each node.

Query string parameters:
local,
master_timeout,
h,
help,
v

See the cat plugins docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html> for more information.

CWrecovery()



    say $e->cat->recovery(
        index => index | \@indices    # optional
    );



Provides a is a view of shard replication. It will show information anytime data from at least one shard is copying to a different node. It can also show up on cluster restarts. If your recovery process seems stuck, try it to see if thereXs any movement using recovery().

Query string parameters:
bytes,
h,
help,
master_timeout,
v

See the cat recovery docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html> for more information.

CWsegments()



    say $e->cat->segments(
        index => index | \@indices    # optional
    );



Provides low level information about the segments in the shards of an index.

Query string parameters:
h,
help,
v

See the cat shards docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html> for more information.

CWshards()



    say $e->cat->shards(
        index => index | \@indices    # optional
    );



Provides a detailed view of what nodes contain which shards, the state and size of each shard.

Query string parameters:
h,
help,
local,
master_timeout,
v

See the cat shards docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html> for more information.

CWthread_pool()



    say $e->cat->thread_pool(
        index => index | \@indices    # optional
    );



Shows cluster wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for the bulk, index and search thread pools.

Query string parameters:
full_id,
h,
help,
local,
master_timeout,
v

See the cat thread_pool docs <http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html> for more information.

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Elasticsearch BV.

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SEARCH::ELASTICSEARCH::CLIENT::1_0::DIRECT::CAT (3) 2015-10-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.