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

Get Scaleup 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/scaleup/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 ScaleUpStatus of type application/json

Succeed to get status.

{
	"component": "DATA_STORAGE",
	"message": "string",
	"progress": 0,
	"state": "SCALE_FEASIBLE",
	"unavailableReason": "INTERNAL_ERROR",
	"volumeSize": 0
}
component Required

Component names for scale up.

Possible values are: DATA_STORAGE


state Required

State for scale out and scale up.

Possible values are: SCALE_FEASIBLESCALE_UNAVAILABLESCALE_ONGOINGSCALE_FAILED


integer as int64
volumeSize Required

Persistent volume size for some specific component, for now it’s minio.


string
message Optional

The reason why last scaleup is not successful. This message will not be reset until a scucessful scaleup happens. This property only appears when it’s in SCALEUP_FAILED state.


integer as int32
progress Optional

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


unavailableReason Optional

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

Possible values are: INTERNAL_ERRORNODE_NOT_READYSERVICE_NOT_READYVOLUME_EXPANSION_NOT_SUPPORTFORM_FACTOR_NOT_SUPPORTED

Errors

Errors

default

unexpected error

Code Samples

Code Samples

cURL Command

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


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

Was this page helpful?