Get Nsx Cluster

Get Nsx Cluster

Retrieve the details of an NSX cluster by its ID

Request
URI
GET
https://sfo-vcf01.rainpole.io/v1/nsxt-clusters/{id}
COPY
Path Parameters
string
id
Required

NSX cluster ID

Responses
200

Ok

Returns NsxTCluster of type(s) application/json 
{
    "domains": [
        {
            "id": "string",
            "name": "string"
        }
    ],
    "id": "string",
    "isShareable": false,
    "isShared": false,
    "isVlcmCompatible": false,
    "nodes": [
        {
            "fqdn": "string",
            "id": "string",
            "ipAddress": "string",
            "name": "string"
        }
    ],
    "status": "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED",
    "version": "string",
    "vip": "string",
    "vipFqdn": "string",
    "nativeId": "string"
}
array of DomainReference
domains
Optional

Information about the domains associated with the cluster

string
id
Optional

ID of the cluster

boolean
isShareable
Optional

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

boolean
isShared
Optional

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

boolean
isVlcmCompatible
Optional

Boolean to identify if the NSX cluster is compatible with Vlcm

array of NsxTManager
nodes
Optional

Information about the NSX managers associated with the cluster

string
status
Optional

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

string
version
Optional

Version of the NSX managers associated with the cluster

string
vip
Optional

VIP (Virtual IP Address) of the cluster

string
vipFqdn
Optional

FQDN for VIP of the cluster

string
nativeId
Optional

Native ID of the NSX cluster


404

NSX cluster not found

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


500

InternalServerError

Returns Error of type(s) application/json 
{
    "arguments": [
        "string"
    ],
    "causes": [
        {
            "message": "string",
            "type": "string"
        }
    ],
    "context": {
        "context": "string"
    },
    "errorCode": "string",
    "errorType": "string",
    "message": "string",
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string",
    "remediationMessage": "string"
}
array of string
arguments
Optional

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

array of ErrorCause
causes
Optional

The underlying cause exceptions.

object
context
Optional

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

string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

string
message
Optional

The localized error message

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.

string
remediationMessage
Optional

The localized remediation error message


On This Page
Nsx T Clusters Operations
GET
Get Nsx Cluster
GET
Get Nsx Cluster Query Response
GET
Get Nsx Clusters
GET
Get Nsx Criteria
GET
Get Nsx Criterion
GET
Get Nsx Ip Address Pool
GET
Get Nsx Ip Address Pools
GET
Get Nsx Transport Zones
GET
Get Validation Result Using GET
POST
Start Nsx Criteria Query
POST
Validate Ip Pool Using POST