NAME
OpenSearch::Client::Core::3_0::Direct::Cat
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->cat-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
CAT APIs
You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The CAT API is a human-readable interface that returns plain text instead of traditional JSON. Using the CAT API, you can answer questions like which node is the elected cluster manager, what state the cluster is in, how many documents are in each index, and so on.
See OpenSearch documentation for cat.
METHODS
aliases
Shows information about aliases currently configured to indexes, including filter and routing information.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->aliases(
# path parameters
'name' => $name, # optional
# Endpoint specific query string parameters
'expand_wildcards' => $qval1, # list
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
's' => $qval6, # list
'v' => $qval7, # boolean
# Common API query string parameters
'error_trace' => $qval8, # boolean
'filter_path' => $qval9, # list
'human' => $qval10, # boolean
'pretty' => $qval11, # boolean
'source' => $qval12, # string
);OpenSearch documentation for cat->aliases
all_pit_segments
Lists all active CAT point-in-time segments.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->cat->all_pit_segments(
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
's' => $qval5, # list
'v' => $qval6, # boolean
# Common API query string parameters
'error_trace' => $qval7, # boolean
'filter_path' => $qval8, # list
'human' => $qval9, # boolean
'pretty' => $qval10, # boolean
'source' => $qval11, # string
);OpenSearch documentation for cat->all_pit_segments
allocation
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->allocation(
# path parameters
'node_id' => $node_id, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'cluster_manager_timeout' => $qval2, # string
'format' => $qval3, # string
'h' => $qval4, # list
'help' => $qval5, # boolean
'local' => $qval6, # boolean
'master_timeout' => $qval7, # string
's' => $qval8, # list
'v' => $qval9, # boolean
# Common API query string parameters
'error_trace' => $qval10, # boolean
'filter_path' => $qval11, # list
'human' => $qval12, # boolean
'pretty' => $qval13, # boolean
'source' => $qval14, # string
);OpenSearch documentation for cat->allocation
cluster_manager
Returns information about the cluster-manager node.
Paths served by this method:
Method added in OpenSearch version 2.0
$resp = $client->cat->cluster_manager(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->cluster_manager
count
Provides quick access to the document count of the entire cluster or of an individual index.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->count(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'format' => $qval1, # string
'h' => $qval2, # list
'help' => $qval3, # boolean
's' => $qval4, # list
'v' => $qval5, # boolean
# Common API query string parameters
'error_trace' => $qval6, # boolean
'filter_path' => $qval7, # list
'human' => $qval8, # boolean
'pretty' => $qval9, # boolean
'source' => $qval10, # string
);OpenSearch documentation for cat->count
fielddata
Shows how much heap memory is currently being used by field data on every data node in the cluster.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->fielddata(
# path parameters
'fields' => $fields, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'fields' => $qval2, # list
'format' => $qval3, # string
'h' => $qval4, # list
'help' => $qval5, # boolean
's' => $qval6, # list
'v' => $qval7, # boolean
# Common API query string parameters
'error_trace' => $qval8, # boolean
'filter_path' => $qval9, # list
'human' => $qval10, # boolean
'pretty' => $qval11, # boolean
'source' => $qval12, # string
);OpenSearch documentation for cat->fielddata
health
Returns a concise representation of the cluster health.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->health(
# Endpoint specific query string parameters
'format' => $qval1, # string
'h' => $qval2, # list
'help' => $qval3, # boolean
's' => $qval4, # list
'time' => $qval5, # string
'ts' => $qval6, # boolean
'v' => $qval7, # boolean
# Common API query string parameters
'error_trace' => $qval8, # boolean
'filter_path' => $qval9, # list
'human' => $qval10, # boolean
'pretty' => $qval11, # boolean
'source' => $qval12, # string
);OpenSearch documentation for cat->health
help
Returns help for the Cat APIs.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->help(
# Common API query string parameters
'error_trace' => $qval1, # boolean
'filter_path' => $qval2, # list
'human' => $qval3, # boolean
'pretty' => $qval4, # boolean
'source' => $qval5, # string
);OpenSearch documentation for cat->help
indices
Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->indices(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'cluster_manager_timeout' => $qval2, # string
'expand_wildcards' => $qval3, # list
'format' => $qval4, # string
'h' => $qval5, # list
'health' => $qval6, # string
'help' => $qval7, # boolean
'include_unloaded_segments' => $qval8, # boolean
'local' => $qval9, # boolean
'master_timeout' => $qval10, # string
'pri' => $qval11, # boolean
's' => $qval12, # list
'time' => $qval13, # string
'v' => $qval14, # boolean
# Common API query string parameters
'error_trace' => $qval15, # boolean
'filter_path' => $qval16, # list
'human' => $qval17, # boolean
'pretty' => $qval18, # boolean
'source' => $qval19, # string
);OpenSearch documentation for cat->indices
master
Returns information about the cluster-manager node.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->master(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->master
nodeattrs
Returns information about custom node attributes.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->nodeattrs(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->nodeattrs
nodes
Returns basic statistics about the performance of cluster nodes.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->nodes(
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'cluster_manager_timeout' => $qval2, # string
'format' => $qval3, # string
'full_id' => $qval4, # boolean
'h' => $qval5, # list
'help' => $qval6, # boolean
'local' => $qval7, # boolean
'master_timeout' => $qval8, # string
's' => $qval9, # list
'time' => $qval10, # string
'v' => $qval11, # boolean
# Common API query string parameters
'error_trace' => $qval12, # boolean
'filter_path' => $qval13, # list
'human' => $qval14, # boolean
'pretty' => $qval15, # boolean
'source' => $qval16, # string
);OpenSearch documentation for cat->nodes
pending_tasks
Returns a concise representation of the cluster's pending tasks.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->pending_tasks(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'time' => $qval8, # string
'v' => $qval9, # boolean
# Common API query string parameters
'error_trace' => $qval10, # boolean
'filter_path' => $qval11, # list
'human' => $qval12, # boolean
'pretty' => $qval13, # boolean
'source' => $qval14, # string
);OpenSearch documentation for cat->pending_tasks
pit_segments
Lists one or several CAT point-in-time segments.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->cat->pit_segments(
'body' => $body, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
's' => $qval5, # list
'v' => $qval6, # boolean
# Common API query string parameters
'error_trace' => $qval7, # boolean
'filter_path' => $qval8, # list
'human' => $qval9, # boolean
'pretty' => $qval10, # boolean
'source' => $qval11, # string
);OpenSearch documentation for cat->pit_segments
plugins
Returns information about the names, components, and versions of the installed plugins.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->plugins(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->plugins
recovery
Returns all completed and ongoing index and shard recoveries.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->recovery(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'active_only' => $qval1, # boolean
'bytes' => $qval2, # string
'detailed' => $qval3, # boolean
'format' => $qval4, # string
'h' => $qval5, # list
'help' => $qval6, # boolean
'index' => $qval7, # list
's' => $qval8, # list
'time' => $qval9, # string
'v' => $qval10, # boolean
# Common API query string parameters
'error_trace' => $qval11, # boolean
'filter_path' => $qval12, # list
'human' => $qval13, # boolean
'pretty' => $qval14, # boolean
'source' => $qval15, # string
);OpenSearch documentation for cat->recovery
repositories
Returns information about all snapshot repositories for a cluster.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->repositories(
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->repositories
segment_replication
Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.
Paths served by this method:
Method added in OpenSearch version 2.6
$resp = $client->cat->segment_replication(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'active_only' => $qval1, # boolean
'allow_no_indices' => $qval2, # boolean
'bytes' => $qval3, # string
'completed_only' => $qval4, # boolean
'detailed' => $qval5, # boolean
'expand_wildcards' => $qval6, # list
'format' => $qval7, # string
'h' => $qval8, # list
'help' => $qval9, # boolean
'ignore_throttled' => $qval10, # boolean
'ignore_unavailable' => $qval11, # boolean
'index' => $qval12, # list
's' => $qval13, # list
'shards' => $qval14, # list
'time' => $qval15, # string
'timeout' => $qval16, # string
'v' => $qval17, # boolean
# Common API query string parameters
'error_trace' => $qval18, # boolean
'filter_path' => $qval19, # list
'human' => $qval20, # boolean
'pretty' => $qval21, # boolean
'source' => $qval22, # string
);OpenSearch documentation for cat->segment_replication
segments
Provides low-level information about the segments in the shards of an index.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->segments(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'cluster_manager_timeout' => $qval2, # string
'format' => $qval3, # string
'h' => $qval4, # list
'help' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->segments
shards
Lists the states of all primary and replica shards and how they are distributed.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->shards(
# path parameters
'index' => $index, # optional
# Endpoint specific query string parameters
'bytes' => $qval1, # string
'cluster_manager_timeout' => $qval2, # string
'format' => $qval3, # string
'h' => $qval4, # list
'help' => $qval5, # boolean
'local' => $qval6, # boolean
'master_timeout' => $qval7, # string
's' => $qval8, # list
'time' => $qval9, # string
'v' => $qval10, # boolean
# Common API query string parameters
'error_trace' => $qval11, # boolean
'filter_path' => $qval12, # list
'human' => $qval13, # boolean
'pretty' => $qval14, # boolean
'source' => $qval15, # string
);OpenSearch documentation for cat->shards
snapshots
Lists all of the snapshots stored in a specific repository.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->snapshots(
# path parameters
'repository' => $repository, # optional
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'ignore_unavailable' => $qval5, # boolean
'master_timeout' => $qval6, # string
'repository' => $qval7, # list
's' => $qval8, # list
'time' => $qval9, # string
'v' => $qval10, # boolean
# Common API query string parameters
'error_trace' => $qval11, # boolean
'filter_path' => $qval12, # list
'human' => $qval13, # boolean
'pretty' => $qval14, # boolean
'source' => $qval15, # string
);OpenSearch documentation for cat->snapshots
tasks
Lists the progress of all tasks currently running on the cluster.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->tasks(
# Endpoint specific query string parameters
'actions' => $qval1, # list
'detailed' => $qval2, # boolean
'format' => $qval3, # string
'h' => $qval4, # list
'help' => $qval5, # boolean
'nodes' => $qval6, # list
'parent_task_id' => $qval7, # string
's' => $qval8, # list
'time' => $qval9, # string
'v' => $qval10, # boolean
# Common API query string parameters
'error_trace' => $qval11, # boolean
'filter_path' => $qval12, # list
'human' => $qval13, # boolean
'pretty' => $qval14, # boolean
'source' => $qval15, # string
);OpenSearch documentation for cat->tasks
templates
Lists the names, patterns, order numbers, and version numbers of index templates.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->templates(
# path parameters
'name' => $name, # optional
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'v' => $qval8, # boolean
# Common API query string parameters
'error_trace' => $qval9, # boolean
'filter_path' => $qval10, # list
'human' => $qval11, # boolean
'pretty' => $qval12, # boolean
'source' => $qval13, # string
);OpenSearch documentation for cat->templates
thread_pool
Returns cluster-wide thread pool statistics per node. By default the active, queued, and rejected statistics are returned for all thread pools.
Paths served by this method:
Method added in OpenSearch version 1.0
$resp = $client->cat->thread_pool(
# path parameters
'thread_pool_patterns' => $thread_pool_patterns, # optional
# Endpoint specific query string parameters
'cluster_manager_timeout' => $qval1, # string
'format' => $qval2, # string
'h' => $qval3, # list
'help' => $qval4, # boolean
'local' => $qval5, # boolean
'master_timeout' => $qval6, # string
's' => $qval7, # list
'size' => $qval8, # number
'v' => $qval9, # boolean
# Common API query string parameters
'error_trace' => $qval10, # boolean
'filter_path' => $qval11, # list
'human' => $qval12, # boolean
'pretty' => $qval13, # boolean
'source' => $qval14, # string
);OpenSearch documentation for cat->thread_pool
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->cat->method_supported_in_version(
method => 'aliases',
version => '2.4.0'
);Both method and version are required.
See also global_method_supported_in_version
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004