Get ALB Cluster
Retrieve an NSX ALB Cluster by its ID
ALB Cluster ID
Ok
{
"id": "string",
"clusterName": "string",
"domains": [
{
"id": "string",
"name": "string",
"type": "string"
}
],
"nsxClusters": [
{
"id": "string",
"vipFqdn": "string",
"vip": "string"
}
],
"clusterFqdn": "string",
"clusterIpAddress": "string",
"clusterStatus": "string",
"version": "string",
"deploymentStatus": "One among: ACTIVE, ACTIVATING, DEACTIVATING"
}ID of the NSX Advanced Load Balancer Cluster
Name of NSX Advanced Load Balancer Cluster
Collection of IDs of Workload Domains where NSX Advanced Load Balancer Cluster is deployed
Collection of IDs of the NSX where NSX Advanced Load Balancer Cluster is deployed
NSX Advanced Load Balancer Cluster Virtual fqdn
NSX Advanced Load Balancer Cluster Virtual IPv4 address of format 'x.x.x.x'
NSX Advanced Load Balancer Cluster status
NSX Advanced Load Balancer Cluster version
NSX Advanced Load Balancer Deployment Status
ALB 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/nsx-alb-clusters/{id}