Get Route Advertisement

Get Route Advertisement

Retrieve the list of subnets that will be advertised so that the Edge Gateway can route out to the connected external network. Org vDC networks that are in any of these subnets can then be routed out to the external networks.

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

gatewayId

string
gatewayId
Required

gatewayId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RouteAdvertisement of type(s) application/json;version=38.1 
{
    "enable": false,
    "subnets": [
        "100.64.1.0/24",
        "fc7e:f206:db42::/48"
    ]
}
boolean
enable
Optional

True means that the subnets will be advertised. The default is true.

array of string
subnets
Optional

List of subnets that will be advertised so that the Edge Gateway can route out to the connected external network. Each value is in CIDR format. Note that the CIDR value will automatically be converted to its network definition based on the prefix length.


404

The specified resource was not found

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

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 34.0
On This Page
Edge Gateway Route Advertisement Operations
GET
Get Route Advertisement
PUT
Update Route Advertisement