GetClusterState

05/25/2022 Contributors

You can use the GetClusterState API method to indicate if a node is part of a cluster or not.

Parameters

This method has no input parameters.

This method has the following return values:

Name	Description	Type
cluster	Name of the cluster.	string
state	Available: Node has not been configured with a cluster name. Pending: Node is pending for a specific named cluster and can be added. Active: Node is an active member of a cluster and may not be added to another cluster.	string

Name

Description

Type

cluster

Name of the cluster.

string

state

Available: Node has not been configured with a cluster name.
Pending: Node is pending for a specific named cluster and can be added.
Active: Node is an active member of a cluster and may not be added to another cluster.

string

Requests for this method are similar to the following example:

{
   "method": "GetClusterState",
   "params": {},
   "id" : 1
}

This method returns a response similar to the following example:

{
   "id" : 1,
   "result" :
      "cluster" :  "Cluster101"
      "state" : "Active"
}

9.6