Get Scaleout Status | NSX Application Platform Cluster API

Get Scaleout Status

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

Request

URI

GET

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

COPY

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

200

Succeed to get status.

Returns Array of ScaleOutStatus of type(s) application/json

[
    {
        "component": "string",
        "state": "string",
        "replica": 0,
        "maxReplica": 0,
        "nextScaleRequiredNode": 0,
        "unavailableReason": "string",
        "progress": 0,
        "message": "string"
    }
]

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

Description

Request

Authentication

Response