Get Service Feature Health

Returns health status of each feature, health status of services in each feature, and the overall cloud native platform services.

Request

URI

GET

https://{api_host}/napp/api/v1/platform/monitor/feature/health

COPY

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

200

health response

Returns FeatureHealthResponse of type(s) application/json

{
    "status": "string",
    "migration_in_progress": false,
    "features": [
        {
            "name": "string",
            "status": "string",
            "services": [
                {
                    "name": "string",
                    "status": "string",
                    "components": [
                        {
                            "name": "string",
                            "status": "string",
                            "readyReplica": 0,
                            "totalReplica": 0,
                            "reason": "string"
                        }
                    ],
                    "prefixes": [
                        "string"
                    ]
                }
            ]
        }
    ]
}

string

status

Required

Health status of the overall cloud native platform and application platform.

Possible values are : UP, PARTIALLY_UP, DOWN,

boolean

migration_in_progress

Optional

True when the NAPP to SSP migration is in progress.

array of FeatureHealth

features

Required

features

500

internal 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