[{"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

URL

post

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

Copy

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.

Show optional properties

{
	"component": "ALL"
}

{
	"component": "ALL",
	"replica": 0
}

ScaleoutComponentLabel Enum

component Required

Component names for scale out.

Possible values are: ALL , MESSAGING , ANALYTICS , DATA_STORAGE , METRICS

integer as int32

replica Optional

Count of current desired replica.

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin

Response

200 OK

Scaleout successful.

Operation doesn't return any data structure.

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.

Error

default

unexpected error

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

Clusterapi Operations

get

Get Scaleout Status

post

Scaleout

Scaleout

Request

URL

Request Body

Authentication

x_nsx_roles

Response

200 OK

Errors

Code Samples

cURL Command

On This Page

Clusterapi Operations

Was this page helpful?