Get Edge Clusters
Retrieve a list of NSX Edge Clusters
Pass an optional vSphere Cluster ID to fetch edge clusters associated with the vSphere Cluster
Ok
{
"elements": [
{
"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
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}The list of elements included in this page
Represents pageable elements pagination metadata
Bad Request
"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