Search::Elasticsearch::Client::7_0::Direct::Cluster - A client for running cluster-level requests
version 7.717
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 Search::Elasticsearch::Role::Client::Direct.
health()
$response = $e->cluster->health( index => 'index' | \@indices # optional );
The health() method is used to retrieve information about the cluster health, returning red, yellow or green to indicate the state of the cluster, indices or shards.
red
yellow
green
Query string parameters: error_trace, human, level, local, master_timeout, timeout, wait_for_active_shards, wait_for_events, wait_for_no_initializing_shards, wait_for_no_relocating_shards, wait_for_nodes, wait_for_status
error_trace
human
level
local
master_timeout
timeout
wait_for_active_shards
wait_for_events
wait_for_no_initializing_shards
wait_for_no_relocating_shards
wait_for_nodes
wait_for_status
See the cluster health docs for more information.
stats()
$response = $e->cluster->stats( node_id => 'node' | \@nodes # optional );
Returns high-level cluster stats, optionally limited to the listed nodes.
Query string parameters: error_trace, flat_settings, human, timeout
flat_settings
See the cluster stats docs for more information.
get_settings()
$response = $e->cluster->get_settings()
The get_settings() method is used to retrieve cluster-wide settings that have been set with the "put_settings()" method.
Query string parameters: error_trace, flat_settings, human, include_defaults, master_timeout, timeout
include_defaults
See the cluster settings docs for more information.
put_settings()
$response = $e->cluster->put_settings( %settings );
The 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" => 6 } } );
Query string parameters: error_trace, flat_settings, human
state()
$response = $e->cluster->state( metric => $metric | \@metrics # optional index => $index | \@indices # optional );
The state() method returns the current cluster state from the master node, or from the responding node if local is set to true.
true
It returns all metrics by default, but these can be limited to any of: _all, blocks, metadata, nodes, routing_table
_all
blocks
metadata
nodes
routing_table
Metrics for indices can be limited to particular indices with the index parameter.
index
Query string parameters: allow_no_indices, error_trace, expand_wildcards, flat_settings, human, ignore_unavailable, local, master_timeout, wait_for_metadata_version, wait_for_timeout
allow_no_indices
expand_wildcards
ignore_unavailable
wait_for_metadata_version
wait_for_timeout
See the cluster state docs for more information.
allocation_explain()
$response = $e->cluster->allocation_explain( body => { ... shard selectors ...} # optional );
Returns information about why a shard is allocated or unallocated or why.
Query string parameters: error_trace, human, include_disk_info, include_yes_decisions
include_disk_info
include_yes_decisions
See the cluster allocation explain docs for more information.
pending_tasks()
$response = $e->cluster->pending_tasks();
Returns a list of cluster-level tasks still pending on the master node.
Query string parameters: error_trace, human, local, master_timeout
See the pending tasks docs for more information.
reroute()
$e->cluster->reroute( body => { commands } );
The reroute() method is used to manually reallocate shards from one node to another. The body should contain the commands indicating which changes should be made. For instance:
body
commands
$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: dry_run, error_trace, explain, human, master_timeout, metric, retry_failed, timeout
dry_run
explain
metric
retry_failed
See the reroute docs for more information.
remote_info()
$response = $e->cluster->remote_info();
The remote_info() API retrieves all of the configured remote cluster information.
Query string parameters: error_trace, human
See the remote_info docs for more information.
Enrico Zimuel <enrico.zimuel@elastic.co>
This software is Copyright (c) 2022 by Elasticsearch BV.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
To install Search::Elasticsearch::Client::7_0, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Elasticsearch::Client::7_0
CPAN shell
perl -MCPAN -e shell install Search::Elasticsearch::Client::7_0
For more information on module installation, please visit the detailed CPAN module installation guide.