Get Prefix List

Get Prefix List

Retrieves a specific Prefix list for a given Edge Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/routing/bgp/prefixLists/{listId}
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
listId
Required

listId

string
externalNetworkId
Required

externalNetworkId

string
listId
Required

listId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderGatewayPrefixList of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "prefixes": [
        {
            "network": "10.22.0.0/22",
            "greaterThanEqualTo": 0,
            "lessThanEqualTo": 0,
            "action": "string"
        }
    ],
    "bgpPermissionGroupRef": {
        "id": "urn:vcloud:bgpPermissionGroup:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "name": "string",
        "accessLevel": "string"
    },
    "version": {
        "version": 0
    }
}
string
id
Optional

The unique id of this prefix list. On updates, the id is required for the list, while for create a new id will be generated. This id is not a VCD URN.

string
name
Required

Name for the prefix list.

string
description
Optional

Description for this prefix list.

array of ProviderGatewayPrefixListEntry
prefixes
Required

List of network prefixes.

ProviderGatewayBgpPermissionGroupReference
bgpPermissionGroupRef
Optional

A BGP Permission Group reference associated with a BGP component. It specifies the the BGP Permission Group along with the access level assigned to the component.

ObjectVersion
version
Optional

This property describes the current version of the entity. To prevent clients from overwriting each other's changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.


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


Availability
Added in 34.0
On This Page
Edge Gateway Prefix List Operations
DELETE
Delete Prefix List
GET
Get Prefix List
PUT
Update Prefix List