Get Edge Cluster

Get Edge Cluster

Retrieve an NSX Edge Cluster by its ID

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

Edge Cluster ID

Responses
200

Ok

Returns EdgeCluster of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "clusters": [
        {
            "id": "string",
            "name": "string"
        }
    ],
    "status": "One among: ACTIVE, ACTIVATING, UPGRADING, DISABLED, ERROR, DEACTIVATING, EXPANDING, SHRINKING, CREATING, SKIPPED",
    "nsxtCluster": {
        "id": "string",
        "vipFqdn": "string",
        "vip": "string"
    },
    "edgeNodes": [
        {
            "id": "string",
            "hostName": "string"
        }
    ],
    "isTier0ManagedBySystem": false,
    "skipTepRoutabilityCheck": false
}
string
id
Optional

ID of the egde cluster

string
name
Optional

Name of the edge cluster

array of ClusterReference
clusters
Optional

List of clusters associated with the edge cluster

string
status
Optional

NSX Edge cluster status

NsxTClusterReference
nsxtCluster
Optional

Represents an NSX Cluster reference

array of EdgeNodeReference
edgeNodes
Optional

List of edge nodes associated with the edge cluster

boolean
isTier0ManagedBySystem
Optional

Whether or not this edge cluster's tier 0 is managed by system

boolean
skipTepRoutabilityCheck
Optional

Whether or not host/TEP network checks were done for this edge cluster


404

Edge 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 Tedge Clusters Operations
POST
Create Edge Cluster
GET
Get Edge Cluster
GET
Get Edge Cluster Query Criteria
GET
Get Edge Clusters
GET
Get Edge Cluster Validation By ID
PATCH
Update Edge Cluster
POST
Validate Edge Cluster Creation Spec
POST
Validate Edge Cluster Update Spec