Get Edge Cluster
Retrieve an NSX Edge Cluster by its ID
Edge Cluster ID
Ok
{
"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
}ID of the egde cluster
Name of the edge cluster
List of clusters associated with the edge cluster
NSX Edge cluster status
Represents an NSX Cluster reference
List of edge nodes associated with the edge cluster
Whether or not this edge cluster's tier 0 is managed by system
Whether or not host/TEP network checks were done for this edge cluster
Edge Cluster not found
"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).
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.
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).
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.
curl -H 'Authorization: <value>' https://{api_host}/v1/edge-clusters/{id}