[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform

Get Scaleout Status

Description

Get scale out status of each component, including max possible replica to scale to, current replica and ready replica.

Request

Request

URL

URL


get
https://{api_host}/napp/api/v1/platform/scale/scaleout/status
Copy

Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin, auditor, security_engineer, security_op

Response

Response

Response Body

Response Body

200 OK returns 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 Required

Component names for scale out.

Possible values are: ALLMESSAGINGANALYTICSDATA_STORAGEMETRICS


integer as int32
maxReplica Required

Max possible replica on current cluster.


integer as int32
nextScaleRequiredNode Required

The minimum number of required Kubernetes worker node to scale out further.


integer as int32
replica Required

Count of current replica.


state Required

State for scale out and scale up.

Possible values are: SCALE_FEASIBLESCALE_UNAVAILABLESCALE_ONGOINGSCALE_FAILED


string
message Optional

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.


integer as int32
progress Optional

Percentage progress of the scale out progress if scale out is going on. This property only appears when it’s in SCALEOUT_ONGOING state.


unavailableReason Optional

The reason why the service is not available to scale out.

Possible values are: INTERNAL_ERRORNODE_NOT_READYSERVICE_NOT_READYMAXIMUM_REPLICA_REACHEDFORM_FACTOR_NOT_SUPPORTED

Errors

Errors

default

unexpected error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/napp/api/v1/platform/scale/scaleout/status


[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-&-application-platform
Feedback

Was this page helpful?