Get Scaleout Status
DescriptionGet scale out status of each component, including max possible replica to scale to, current replica and ready replica.
Request
URL
Authentication
x_nsx_roles
Response
Response BodyResponse Body
200 OK
array of
ScaleOutStatus
of type application/json
Succeed to get status.
{
"component": "ALL",
"maxReplica": 0,
"message": "string",
"nextScaleRequiredNode": 0,
"progress": 0,
"replica": 0,
"state": "SCALE_FEASIBLE",
"unavailableReason": "INTERNAL_ERROR"
}
Component names for scale out.
Possible values are: ALL , MESSAGING , ANALYTICS , DATA_STORAGE , METRICS
Max possible replica on current cluster.
The minimum number of required Kubernetes worker node to scale out further.
Count of current replica.
State for scale out and scale up.
Possible values are: SCALE_FEASIBLE , SCALE_UNAVAILABLE , SCALE_ONGOING , SCALE_FAILED
The reason why last scaleout is not successful. This message will not be reset until a scucessful scaleout happens. This property only appears when it’s in SCALEOUT_FAILED state.
Percentage progress of the scale out progress if scale out is going on. This property only appears when it’s in SCALEOUT_ONGOING state.
The reason why the service is not available to scale out.
Possible values are: INTERNAL_ERROR , NODE_NOT_READY , SERVICE_NOT_READY , MAXIMUM_REPLICA_REACHED , FORM_FACTOR_NOT_SUPPORTED
Errors
unexpected error
