Scaleout

Scaleout

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
URI
POST
https://{api_host}/napp/api/v1/platform/scale/scaleout
COPY
Request Body

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

Array of ScaleOutRequest of type(s) application/json
Optional 
[
    {
        "component": "string",
        "replica": 0
    }
]
Authentication
This operation uses the following authentication methods.
Responses
200

Scaleout successful.

Operation doesn't return any data structure

404

Component in request is not valid.

Operation doesn't return any data structure

422

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

Operation doesn't return any data structure

default

unexpected error

Returns Error of type(s) application/json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

Error code refers to either HTTP status code OR a unique code identifying the internal error - which can be referenced in VMware documents for more information.

string
message
Required

Descriptive user understandable error message to help identify root cause of the error.


Deprecated
Availability
Deprecated in 4.2
On This Page
Clusterapi Operations
GET
Get Scaleout Status
Deprecated
POST
Scaleout
Deprecated