Read Cluster Node Status

Request

URI

GET

https://nsxmanager.your.domain/api/v1/cluster/nodes/{node-id}/status

COPY

Path Parameters

string

node-id

Required

node-id

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns ClusterNodeStatus of type(s) application/json

{
    "system_status": {
        "load_average": [
            "number"
        ],
        "swap_used": 0,
        "mem_used": 0,
        "swap_total": 0,
        "system_time": 0,
        "cpu_cores": 0,
        "uptime": 0,
        "mem_cache": 0,
        "mem_total": 0,
        "file_systems": [
            {
                "mount": "string",
                "total": 0,
                "type": "string",
                "file_system": "string",
                "used": 0
            }
        ],
        "source": "string"
    },
    "mgmt_cluster_status": {
        "mgmt_cluster_status": "string"
    },
    "version": "string",
    "control_cluster_status": {
        "mgmt_connection_status": {
            "connectivity_status": "string"
        },
        "control_cluster_status": "string"
    }
}

NodeStatusProperties

system_status

Optional

system_status

ManagementClusterNodeStatus

mgmt_cluster_status

Optional

mgmt_cluster_status

string

version

Optional

Software version running on node

ControlClusterNodeStatus

control_cluster_status

Optional

control_cluster_status

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Not Found

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error