New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Miscellaneous APIs Ping API »
Elastic Docs ›Java REST Client [6.3] ›Java High Level REST Client ›Miscellaneous APIs

Info API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Info API

edit

Execution

edit

Cluster information can be retrieved using the info() method:

MainResponse response = client.info();

Response

edit

The returned MainResponse provides various kinds of information about the cluster:

ClusterName clusterName = response.getClusterName(); 
String clusterUuid = response.getClusterUuid(); 
String nodeName = response.getNodeName(); 
Version version = response.getVersion(); 
Build build = response.getBuild();

Retrieve the name of the cluster as a ClusterName

Retrieve the unique identifier of the cluster

Retrieve the name of the node the request has been executed on

Retrieve the version of the node the request has been executed on

Retrieve the build information of the node the request has been executed on
« Miscellaneous APIs Ping API »

On this page

Was this helpful?
Feedback