Get Universal Router

Get Universal Router

Retrieves a specific Universal Router

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

universalRouterId

string
universalRouterId
Required

universalRouterId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UniversalRouter of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "vdcGroupRef": {
        "name": "string",
        "id": "string"
    },
    "localEgress": false,
    "status": {},
    "errorMessage": "string"
}
string
id
Optional

id

string
name
Required

name

string
description
Optional

description

EntityReference
vdcGroupRef
Required

Entity reference used to describe VCD entities

boolean
localEgress
Optional

localEgress

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
Universal Router Operations
DELETE
Delete Universal Router
GET
Get Universal Router
POST
Sync Universal Router
PUT
Update Universal Router