NAME
OpenSearch::Client::Core::3_0::Direct::List
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->list-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
List APIs
The List API retrieves statistics about indexes and shards in a paginated format. This streamlines the task of processing responses that include many indexes.
See OpenSearch documentation for list.
METHODS
help
Returns help for the List APIs.
Paths served by this method:
Method added in OpenSearch version 2.18
$resp = $client->list->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 list->help
indices
Returns paginated information about indexes including number of primaries and replicas, document counts, disk size.
Paths served by this method:
Method added in OpenSearch version 2.18
$resp = $client->list->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
'next_token' => $qval11, # string
'pri' => $qval12, # boolean
's' => $qval13, # list
'size' => $qval14, # number
'sort' => $qval15, # string
'time' => $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 list->indices
shards
Returns paginated details of shard allocation on nodes.
Paths served by this method:
Method added in OpenSearch version 2.18
$resp = $client->list->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
'next_token' => $qval8, # string
's' => $qval9, # list
'size' => $qval10, # number
'sort' => $qval11, # string
'time' => $qval12, # string
'v' => $qval13, # boolean
# Common API query string parameters
'error_trace' => $qval14, # boolean
'filter_path' => $qval15, # list
'human' => $qval16, # boolean
'pretty' => $qval17, # boolean
'source' => $qval18, # string
);OpenSearch documentation for list->shards
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->list->method_supported_in_version(
method => 'help',
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