Get ALB Cluster

Get ALB Cluster

Retrieve an NSX ALB Cluster by its ID

Request
URI
GET
https://{api_host}/v1/nsx-alb-clusters/{id}
COPY
Path Parameters
string
id
Required

ALB Cluster ID

Responses
200

Ok

Returns NsxALBCluster of type(s) application/json 
{
    "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"
}
string
id
Optional

ID of the NSX Advanced Load Balancer Cluster

string
clusterName
Optional

Name of NSX Advanced Load Balancer Cluster

array of DomainReference
domains
Optional

Collection of IDs of Workload Domains where NSX Advanced Load Balancer Cluster is deployed

array of NsxTClusterReference
nsxClusters
Optional

Collection of IDs of the NSX where NSX Advanced Load Balancer Cluster is deployed

string
clusterFqdn
Optional

NSX Advanced Load Balancer Cluster Virtual fqdn

string
clusterIpAddress
Optional

NSX Advanced Load Balancer Cluster Virtual IPv4 address of format 'x.x.x.x'

string
clusterStatus
Optional

NSX Advanced Load Balancer Cluster status

string
version
Optional

NSX Advanced Load Balancer Cluster version

string
deploymentStatus
Optional

NSX Advanced Load Balancer Deployment Status


404

ALB 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.

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.


On This Page
Nsx Albclusters Operations
DELETE
Delete ALB Cluster
GET
Get ALB Cluster
GET
Get ALB Clusters
GET
Get ALB Clusters Form Factors
POST
Validate ALB Cluster Creation Spec
POST
Validate Nsx ALB Compatibility