Overview | Service | Command |
Get Cluster Status
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<GetClusterStatusRequest /> ## GetClusterStatusRequest
<GetClusterStatusResponse> ## GetClusterStatusResponse
<clusterName>{clusterName} (String)</clusterName>
<servers>
(<server name="{cluster-server-name}" status="{cluster-server-status} (int)" /> ## ClusterServerInfo)*
</servers>
<services>
(<service name="{cluster-service-name}" state="{cluster-service-name}"
owner="{cluster-service-owner-server}" lastOwner="{cluster-service-last-owner-server}" /> ## ClusterServiceInfo)*
</services>
</GetClusterStatusResponse>
The following table describes elements and attributes you can define within a
<GetClusterStatusResponse>
element:
XPath | Required / Optional | Description |
/clusterName | Optional (0 or 1) | Type:{clusterName} (String) Cluster name |
/servers | Required (only 1) | |
/servers/server | Optional (0 or more) | |
/servers/server@name | Required (only 1) | Type:String Cluster server name |
/servers/server@status | Required (only 1) | Type:int Server status - 1 or 0 |
/services | Required (only 1) | |
/services/service | Optional (0 or more) | |
/services/service@name | Required (only 1) | Type:String Cluster service name |
/services/service@state | Required (only 1) | Type:String Cluster service name |
/services/service@owner | Required (only 1) | Type:String Name of server that owns this service |
/services/service@lastOwner | Required (only 1) | Type:String Name of server that last owned this service |