/ 
OpenSearch-Client-3.007004
/ OpenSearch::Client::Core::3_0::Direct::Nodes

NAME

OpenSearch::Client::Core::3_0::Direct::Nodes

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->nodes-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Nodes APIs

The Nodes API makes it possible to retrieve information about individual nodes in your cluster.

See OpenSearch documentation for nodes.

METHODS

nodes->hot_threads

Returns information about hot threads on each node in the cluster.

Paths served by this method:

GET /_nodes/hot_threads
GET /_nodes/{node_id}/hot_threads
$resp = $client->nodes->hot_threads(
    
     # path parameters
    
    'node_id'              =>  $node_id,   # optional
    
     # Endpoint specific query string parameters
    
    'ignore_idle_threads'  =>  $qval1,     # boolean
    'interval'             =>  $qval2,     # string
    'snapshots'            =>  $qval3,     # number
    'threads'              =>  $qval4,     # number
    'timeout'              =>  $qval5,     # string
    'type'                 =>  $qval6,     # string
    
     # 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 nodes.hot_threads

nodes->info

Returns information about nodes in the cluster.

Paths served by this method:

GET /_nodes
GET /_nodes/{metric}
GET /_nodes/{node_id}
GET /_nodes/{node_id}/{metric}
$resp = $client->nodes->info(
    
     # path parameters
    
    'metric'         =>  $metric,    # optional
    'node_id'        =>  $node_id,   # optional
    
     # Endpoint specific query string parameters
    
    'flat_settings'  =>  $qval1,     # boolean
    'timeout'        =>  $qval2,     # string
    
     # Common API query string parameters
    
    'error_trace'    =>  $qval3,     # boolean
    'filter_path'    =>  $qval4,     # list
    'human'          =>  $qval5,     # boolean
    'pretty'         =>  $qval6,     # boolean
    'source'         =>  $qval7,     # string
);

OpenSearch documentation for nodes.info

nodes->reload_secure_settings

Reloads secure settings.

Paths served by this method:

POST /_nodes/reload_secure_settings
POST /_nodes/{node_id}/reload_secure_settings
$resp = $client->nodes->reload_secure_settings(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'node_id'      =>  $node_id,   # optional
    
     # Endpoint specific query string parameters
    
    'timeout'      =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for nodes.reload_secure_settings

nodes->stats

Returns statistical information about nodes in the cluster.

Paths served by this method:

GET /_nodes/stats
GET /_nodes/stats/{metric}
GET /_nodes/stats/{metric}/{index_metric}
GET /_nodes/{node_id}/stats
GET /_nodes/{node_id}/stats/{metric}
GET /_nodes/{node_id}/stats/{metric}/{index_metric}
$resp = $client->nodes->stats(
    
     # path parameters
    
    'index_metric'                =>  $index_metric,  # optional
    'metric'                      =>  $metric,    # optional
    'node_id'                     =>  $node_id,   # optional
    
     # Endpoint specific query string parameters
    
    'completion_fields'           =>  $qval1,     # list
    'fielddata_fields'            =>  $qval2,     # list
    'fields'                      =>  $qval3,     # list
    'groups'                      =>  $qval4,     # list
    'include_segment_file_sizes'  =>  $qval5,     # boolean
    'level'                       =>  $qval6,     # string
    'timeout'                     =>  $qval7,     # string
    'types'                       =>  $qval8,     # list
    
     # 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 nodes.stats

nodes->usage

Returns low-level information about REST actions usage on nodes.

Paths served by this method:

GET /_nodes/usage
GET /_nodes/usage/{metric}
GET /_nodes/{node_id}/usage
GET /_nodes/{node_id}/usage/{metric}
$resp = $client->nodes->usage(
    
     # path parameters
    
    'metric'       =>  $metric,    # optional
    'node_id'      =>  $node_id,   # optional
    
     # Endpoint specific query string parameters
    
    'timeout'      =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for nodes.usage

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