Get Edge Gateway

Get Edge Gateway

Retrieves a specific Edge Gateway

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
gatewayId
Required

gatewayId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeGateway of type(s) application/json;version=38.0
This response body class contains all of the following: NetworkingObjectStatus , InlineEdgeGateway1 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "edgeGatewayUplinks": [
        {
            "uplinkId": "string",
            "uplinkName": "string",
            "subnets": {
                "values": [
                    {
                        "gateway": "string",
                        "prefixLength": 0,
                        "dnsSuffix": "string",
                        "dnsServer1": "string",
                        "dnsServer2": "string",
                        "ipRanges": {
                            "values": [
                                {
                                    "startAddress": "string",
                                    "endAddress": "string"
                                }
                            ]
                        },
                        "enabled": false,
                        "totalIpCount": 0,
                        "usedIpCount": 0,
                        "primaryIp": "string",
                        "autoAllocateIpRanges": false
                    }
                ]
            },
            "connected": false,
            "quickAddAllocatedIpCount": 0,
            "dedicated": false,
            "usingIpSpace": false,
            "vrfLiteBacked": false,
            "backingType": "string"
        }
    ],
    "distributedRoutingEnabled": false,
    "nonDistributedRoutingEnabled": false,
    "orgVdcNetworkCount": 0,
    "gatewayBacking": {
        "backingId": "string",
        "networkProvider": {
            "name": "string",
            "id": "string"
        },
        "isUniversalVdcGroupEdge": false
    },
    "orgVdc": {
        "name": "string",
        "id": "string"
    },
    "ownerRef": {
        "name": "string",
        "id": "string"
    },
    "orgRef": {
        "name": "string",
        "id": "string"
    },
    "serviceNetworkDefinition": "string",
    "distributedRouterUplinkNetworkDefinition": "string",
    "edgeClusterConfig": {
        "primaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeCluster": {
            "edgeClusterRef": {
                "name": "string",
                "id": "string"
            },
            "backingId": "string",
            "networkProviderScope": "string",
            "nsxTManagerRef": {
                "name": "string",
                "id": "string"
            }
        },
        "secondaryEdgeClusters": [
            {
                "edgeClusterRef": {
                    "name": "string",
                    "id": "string"
                },
                "backingId": "string",
                "networkProviderScope": "string",
                "nsxTManagerRef": {
                    "name": "string",
                    "id": "string"
                }
            }
        ]
    }
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=38.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
Edge Gateway Operations
DELETE
Delete Edge Gateway
GET
Get Edge Gateway
GET
Get Used Ip Addresses
PUT
Update Edge Gateway