Management Plane API >
Networking
>
Logical Routing And Services
>
Routing Configuration
Paginated list of BGP community lists on a logical router
Paginated list of BGP Community Lists on a Logical Router
Request:
Method:
GET
URI Path(s):
/api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists
Request Headers:
n/a
Query Parameters:
ListRequestParameters
+
ListRequestParameters
(
schema
)
Name
Description
Type
Notes
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Comma separated list of fields that should be included in query result
string
page_size
Maximum number of results to return in this page (server may return fewer)
integer
Minimum: 0
Maximum: 1000
Default: "1000"
sort_ascending
boolean
sort_by
Field by which records are sorted
string
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/logical-routers/7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c/routing/bgp/community-lists
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
BGPCommunityListListResult
+
BGPCommunityListListResult
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
Readonly
result_count
Count of results found (across all pages), set only on first page
integer
Readonly
results
List of bgp communities
Paginated list of bgp community lists
array of
BGPCommunityList
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Response:
{ "cursor": "0036640912b0-4820-46f0-b7c2-7a9e2cb57505neighbor2", "result_count": 2, "results": [ { "id": "a9478c1d-d7ab-47c5-9e05-548920f4d88c", "resource_type": "BGPCommunityList" "communities": ["10:50", "10:52"], "community_type": "NormalBGPCommunity", "_last_modified_time": 1433948850593, "_create_time": 1433948850593, "_create_user": "admin", "_last_modified_user": "admin", "_revision": 0 }, { "id": "640912b0-4820-46f0-b7c2-7a9e2cb57505", "resource_type": "BGPCommunityList" "communities": ["11:09", "11:10"], "community_type": "NormalBGPCommunity", "_last_modified_time": 1433960878203, "_create_time": 1433949148014, "_create_user": "admin", "_last_modified_user": "admin", "_revision": 4 } ] }
Required Permissions:
read
Feature:
routing_routers
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable