Get Nsx Cluster
Retrieve the details of an NSX cluster by its ID
NSX cluster ID
Retrieve the NSX-T external properties (native cluster ID) when this parameter is set to true
Ok
{
"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"
}ID of the cluster
Native ID of the NSX cluster
FQDN for VIP of the cluster
[Deprecated] VIP (Virtual IP Address) of the cluster
Information about the domains associated with the cluster
Information about the NSX managers associated with the cluster
Version of the NSX managers associated with the cluster
Boolean to identify if the NSX cluster is shared among workload domains
Boolean to identify if the NSX cluster can be shared to create a new workload domain
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
NSX cluster status. To get NSX cluster status invoke nsxt-clusters query API with criterion NSXT_CLUSTERS_WITH_STATUS
NSX cluster not found
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
The nested errors when the error is a composite one
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
InternalServerError
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -H 'Authorization: <value>' https://{api_host}/v1/nsxt-clusters/{id}