view release on metacpan or  search on metacpan

lib/OpenSearch/Client/Core/3_0/Direct/Cluster.pm  view on Meta::CPAN

=back

I<Method added in OpenSearch version 1.0>


    $resp = $client->cluster->get_weighted_routing(
        
         # path parameters
        
        'attribute'    =>  $attribute,  # required
        
         # Common API query string parameters
        
        'error_trace'  =>  $qval1,     # boolean
        'filter_path'  =>  $qval2,     # list
        'human'        =>  $qval3,     # boolean
        'pretty'       =>  $qval4,     # boolean
        'source'       =>  $qval5,     # string
    );

L<OpenSearch documentation for cluster-E<gt>get_weighted_routing|https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones>
    
=head2 health

Returns basic information about the health of the cluster.

I<Paths served by this method:>

=over

=item
C<GET /_cluster/health>

=item
C<GET /_cluster/health/{index}>

=back

I<Method added in OpenSearch version 1.0>


    $resp = $client->cluster->health(
        
         # path parameters
        
        'index'                            =>  $index,     # optional
        
         # Endpoint specific query string parameters
        
        'awareness_attribute'              =>  $qval1,     # string
        'cluster_manager_timeout'          =>  $qval2,     # string
        'expand_wildcards'                 =>  $qval3,     # list
        'level'                            =>  $qval4,     # string
        'local'                            =>  $qval5,     # boolean
        'master_timeout'                   =>  $qval6,     # string
        'timeout'                          =>  $qval7,     # string
        'wait_for_active_shards'           =>  $qval8,     # string
        'wait_for_events'                  =>  $qval9,     # string
        'wait_for_no_initializing_shards'  =>  $qval10,    # boolean
        'wait_for_no_relocating_shards'    =>  $qval11,    # boolean
        'wait_for_nodes'                   =>  $qval12,    # number|string
        'wait_for_status'                  =>  $qval13,    # string
        
         # Common API query string parameters
        
        'error_trace'                      =>  $qval14,    # boolean
        'filter_path'                      =>  $qval15,    # list
        'human'                            =>  $qval16,    # boolean
        'pretty'                           =>  $qval17,    # boolean
        'source'                           =>  $qval18,    # string
    );

L<OpenSearch documentation for cluster-E<gt>health|https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/>
    
=head2 pending_tasks

Returns a list of pending cluster-level tasks, such as index creation, mapping updates,
or new allocations.

I<Paths served by this method:>

=over

=item
C<GET /_cluster/pending_tasks>

=back

I<Method added in OpenSearch version 1.0>


    $resp = $client->cluster->pending_tasks(
        
         # Endpoint specific query string parameters
        
        'cluster_manager_timeout'  =>  $qval1,     # string
        'local'                    =>  $qval2,     # boolean
        'master_timeout'           =>  $qval3,     # string
        
         # Common API query string parameters
        
        'error_trace'              =>  $qval4,     # boolean
        'filter_path'              =>  $qval5,     # list
        'human'                    =>  $qval6,     # boolean
        'pretty'                   =>  $qval7,     # boolean
        'source'                   =>  $qval8,     # string
    );

L<OpenSearch documentation for cluster-E<gt>pending_tasks|https://docs.opensearch.org/latest/api-reference/cluster-api/index/>
    
=head2 post_voting_config_exclusions

Updates the cluster voting configuration by excluding certain node IDs or names.

I<Paths served by this method:>

=over

=item
C<POST /_cluster/voting_config_exclusions>