1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
package Search::Elasticsearch::Client::2_0::Direct::Cluster;
$Search::Elasticsearch::Client::2_0::Direct::Cluster::VERSION = '6.81';
use Moo;
with 'Search::Elasticsearch::Client::2_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
__PACKAGE__->_install_api('cluster');
1;
=pod
=encoding UTF-8
=head1 NAME
Search::Elasticsearch::Client::2_0::Direct::Cluster - A client for running cluster-level requests
=head1 VERSION
version 6.81
=head1 DESCRIPTION
This module provides methods to make cluster-level requests, such as
getting and setting cluster-level settings, manually rerouting shards,
and retrieving for monitoring purposes.
It does L<Search::Elasticsearch::Role::Client::Direct>.
=head1 METHODS
=head2 C<health()>
$response = $e->cluster->health(
index => 'index' | \@indices # optional
);
The C<health()> method is used to retrieve information about the cluster
health, returning C<red>, C<yellow> or C<green> to indicate the state
of the cluster, indices or shards.
Query string parameters:
C<level>,
C<local>,
C<master_timeout>,
C<timeout>,
C<wait_for_active_shards>,
C<wait_for_nodes>,
C<wait_for_relocating_shards>,
C<wait_for_status>
See the L<cluster health docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html>
for more information.
=head2 C<stats()>
$response = $e->cluster->stats(
node_id => 'node' | \@nodes # optional
);
Returns high-level cluster stats, optionally limited to the listed nodes.
Query string parameters:
C<flat_settings>,
C<human>,
C<timeout>
See the L<cluster stats docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html>
for more information.
=head2 C<get_settings()>
$response = $e->cluster->get_settings()
The C<get_settings()> method is used to retrieve cluster-wide settings that
have been set with the L</put_settings()> method.
Query string parameters:
C<flat_settings>,
C<master_timeout>,
C<timeout>
See the L<cluster settings docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html>
for more information.
=head2 C<put_settings()>
$response = $e->cluster->put_settings( %settings );
The C<put_settings()> method is used to set cluster-wide settings, either
transiently (which don't survive restarts) or permanently (which do survive
restarts).
For instance:
$response = $e->cluster->put_settings(
body => {
transient => { "discovery.zen.minimum_master_nodes" => 5 }
}
);
Query string parameters:
C<flat_settings>
See the L<cluster settings docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html>
for more information.
=head2 C<state()>
$response = $e->cluster->state(
metric => $metric | \@metrics # optional
index => $index | \@indices # optional
);
The C<state()> method returns the current cluster state from the master node,
or from the responding node if C<local> is set to C<true>.
It returns all metrics by default, but these can be limited to any of:
C<_all>,
C<blocks>,
C<metadata>,
C<nodes>,
C<routing_table>
Metrics for indices can be limited to particular indices with the C<index>
parameter.
Query string parameters:
C<allow_no_indices>,
C<expand_wildcards>,
C<flat_settings>,
C<ignore_unavailable>,
C<local>,
C<master_timeout>
See the L<cluster state docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html>
for more information.
=head2 C<pending_tasks()>
$response = $e->cluster->pending_tasks();
Returns a list of cluster-level tasks still pending on the master node.
Query string parameters:
C<local>,
C<master_timeout>
See the L<pending tasks docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html>
for more information.
=head2 C<reroute()>
$e->cluster->reroute(
body => { commands }
);
The C<reroute()> method is used to manually reallocate shards from one
node to another. The C<body> should contain the C<commands> indicating
which changes should be made. For instance:
$e->cluster->reroute(
body => {
commands => [
{ move => {
index => 'test',
shard => 0,
from_node => 'node_1',
to_node => 'node_2
}},
{ allocate => {
index => 'test',
shard => 1,
node => 'node_3'
}}
]
}
);
Query string parameters:
C<dry_run>,
C<explain>,
C<master_timeout>,
C<metric>,
C<timeout>
See the L<reroute docs|http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html>
for more information.
=head1 AUTHOR
Enrico Zimuel <enrico.zimuel@elastic.co>
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2020 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
__END__
# ABSTRACT: A client for running cluster-level requests
|
