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

Scaleout

Description

Scale out components in a recommended way or with replica specified. This request returns when the reuqest is validated, to get progress of the scaleout, please use /scale/status to track.

Request

Request

URL

URL


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

Request Body

Request Body

array of ScaleOutRequest of mimetype application/json Required

Request is an array of ScaleOutRequest, which contains component name and replica count, which is optional.

{
	"component": "ALL"
}
component Required

Component names for scale out.

Possible values are: ALLMESSAGINGANALYTICSDATA_STORAGEMETRICS


integer as int32
replica Optional

Count of current desired replica.

Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin

Response

Response

200 OK

Scaleout successful.

Errors

Errors

404

Component in request is not valid.


422

Replica count in request is not valid, less than current replica or larger than maximum possible replica.


default

unexpected error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '[{"component":"ALL","replica":0}]' https://{api_host}/napp/api/v1/platform/scale/scaleout


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

Was this page helpful?