API V3 Documentation – CLU
Preview: this documents PQFORCE 4.26.6, which has not been released yet.
Data types
CLU.ClusterState
This is a structure data contract.
Diagnostic information about cluster state
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
state |
States | ✔️ | An enum defining current state | |
responseTime |
long? | ✔️ | The (average) response time in ms | |
load |
int? | ✔️ | An indicator about load, ranging from 0-100 | |
totalNodes |
int | The total number of nodes in cluster | ||
runningNodes |
int | The number of nodes running | ||
nodes |
array of NodeState | Information about cluster | null;non-null (The array is optional. Each element must not be null.) |
CLU.NodeState
This is a structure data contract.
State information about a node
Based on
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
state |
States | ✔️ | An enum defining current state | |
responseTime |
long? | ✔️ | The (average) response time in ms | |
load |
int? | ✔️ | An indicator about load, ranging from 0-100 |
CLU.State
This is a structure data contract.
Generic state information about a cluster or a node
Members
| Name | Type | Inherited | Description | Assertion |
|---|---|---|---|---|
state |
States | An enum defining current state | ||
responseTime |
long? | The (average) response time in ms | ||
load |
int? | An indicator about load, ranging from 0-100 |
CLU.States
This is an enumeration data contract.
Describes state of a node or cluster
Enum values
| ID | Description |
|---|---|
Down |
The node or cluster is down |
Up |
The node or cluster is up |