Get Nsx Cluster | VMware Cloud Foundation API

Get Nsx Cluster

Retrieve the details of an NSX cluster by its ID

Request

URI

GET

https://{api_host}/v1/nsxt-clusters/{id}

COPY

Path Parameters

string

Required

NSX cluster ID

Responses

200

Returns NsxTCluster of type(s) application/json

{
    "id": "string",
    "nativeId": "string",
    "vipFqdn": "string",
    "vip": "string",
    "domains": [
        {
            "id": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "nodes": [
        {
            "id": "string",
            "fqdn": "string",
            "ipAddress": "string",
            "name": "string"
        }
    ],
    "version": "string",
    "isShared": false,
    "isShareable": false,
    "isVlcmCompatible": false,
    "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED"
}

string

Optional

ID of the cluster

string

nativeId

Optional

[Deprecated] Native ID of the NSX cluster

string

vipFqdn

Optional

FQDN for VIP of the cluster

string

vip

Optional

VIP (Virtual IP Address) of the cluster

array of DomainReference

domains

Optional

Information about the domains associated with the cluster

array of NsxTManager

nodes

Optional

Information about the NSX managers associated with the cluster

string

version

Optional

Version of the NSX managers associated with the cluster

boolean

isShared

Optional

Boolean to identify if the NSX cluster is shared among workload domains

boolean

isShareable

Optional

Boolean to identify if the NSX cluster can be shared to create a new workload domain

boolean

isVlcmCompatible

Optional

Boolean to identify if the NSX cluster is compatible with vLCM. This should not be used to determineif vLCM Clusters can be created on the domain

string

status

Optional

NSX cluster status. To get NSX cluster status invoke nsxt-clusters query API with criterion NSXT_CLUSTERS_WITH_STATUS

404

NSX cluster not found

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of ErrorCause

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.