Get Nsx T Edge Clusters

Returns all the configured NSX-T edge clusters for an Org VDC or a VDC Group or a Provider VDC or NSX-T Manager. Supported filters are:

orgVdcId - | The filter orgVdcId must be set equal to the id of the NSX-T backed Org VDC for which we want to get the edge clusters. Example: (orgVdcId==urn:vcloud:vdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
vdcGroupId - | The filter vdcGroupId must be set equal to the id of the NSX-T VDC Group for which we want to get the edge clusters. Example: (vdcGroupId==urn:vcloud:vdcGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
pvdcId - | The filter pvdcId must be set equal to the id of the NSX-T backed Provider VDC for which we want to get the edge clusters. pvdcId filter is supported from version 35.2 Example: (pvdcId==urn:vcloud:providervdc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
nsxTManagerRef.id - | The filter nsxTManagerRef.id must be set equal to the id of the NSX-T manager for which we want to get the edge clusters. nsxTManagerRef.id filter is supported from version 39.0 Example: (nsxTManagerRef.id==urn:vcloud:nsxtmanager:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)

Use of "_context" filter has been deprecated. Please use supported filters.

Request

URI

GET

https://{api_host}/cloudapi/1.0.0/nsxTResources/edgeClusters

COPY

Query Parameters

string

filter

Optional

Filter for a query. FIQL format.

string

cursor

Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer

pageSize

Required

Results per page to fetch.

string

sortAsc

Optional

Field to use for ascending sort

string

sortDesc

Optional

Field to use for descending sort

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns NsxTEdgeClusters of type(s) application/json;version=39.0

{
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "nodeCount": 0,
            "nodeType": {},
            "deploymentType": {},
            "alreadyImported": false,
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        }
    ]
}

array of NsxTEdgeCluster

values

Optional

values

Availability

Added in 34.0

On This Page

Description

Request

Query Parameters

Authentication

Response