Get Egress Point

Get Egress Point

Retrieves a specific Universal Egress Point.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/universalRouters/{universalRouterId}/routing/egressPoints/{egressPointId}
COPY
Path Parameters
string
universalRouterId
Required

universalRouterId

string
egressPointId
Required

egressPointId

string
universalRouterId
Required

universalRouterId

string
egressPointId
Required

egressPointId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EgressPoint of type(s) application/json;version=39.0 
{
    "id": "string",
    "vdcRef": {
        "name": "string",
        "id": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    },
    "networkProviderScope": "string",
    "isUsedForRouting": false,
    "status": {},
    "errorMessage": "string"
}
string
id
Optional

The unique ID for the Universal Egress Point (read-only).

EntityReference
vdcRef
Optional

Entity reference used to describe VCD entities

EntityReference
gatewayRef
Optional

Entity reference used to describe VCD entities

string
networkProviderScope
Optional

Read-only field that specifies the network provider scope of the Universal Egress Point (inherited from the Org vDC).

boolean
isUsedForRouting
Optional

Specifies whether the egress point is being used for Universal Routing. This is a read-only field.

VdcGroupEntityStatus
status
Optional

Represents status of vDC group components such as participating vdc's configured routing, egress points, etc.

Possible values are : SAVING, SAVED, CONFIGURING, REALIZED, REALIZATION_FAILED, DELETING, DELETE_FAILED, OBJECT_NOT_FOUND, UNCONFIGURED,
string
errorMessage
Optional

errorMessage


404

The specified resource was not found

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

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


On This Page
Egress Point Operations
DELETE
Delete Egress Point
GET
Get Egress Point
POST
Sync Egress Point