Get Edge Clusters | VMware Cloud Foundation API

Get Edge Clusters

Retrieve a list of NSX Edge Clusters

Request

URI

GET

https://{api_host}/v1/edge-clusters

COPY

Query Parameters

string

clusterId

Optional

Pass an optional vSphere Cluster ID to fetch edge clusters associated with the vSphere Cluster

Responses

200

Returns PageOfEdgeCluster of type(s) application/json

{
    "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
    }
}

array of EdgeCluster

elements

Optional

The list of elements included in this page

PageMetadata

pageMetadata

Optional

Represents pageable elements pagination metadata

400

Bad Request

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.