Policy >
Networking
>
Connectivity
>
Tier-0 Gateways
>
Routing
>
Community Lists
List BGP community lists
Paginated list of all community lists under a tier-0
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost) or VMware NSX-T.
Request:
Method:
GET
URI Path(s):
/policy/api/v1/infra/tier-0s/<tier-0-id>/community-lists
/policy/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters
+
PolicyListRequestParameters
(
schema
)
Name
Description
Type
Notes
cursor
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
include_mark_for_delete_objects
Include objects that are marked for deletion in results
If true, resources that are marked for deletion will be included
in the results. By default, these resources are not included.
boolean
Default: "False"
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://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/community-lists
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
CommunityListListResult
+
CommunityListListResult
(
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
CommunityList results
array of
CommunityList
Required
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Response:
{ "sort_ascending": true, "sort_by": "display_name", "result_count": 1, "results": [ { "resource_type": "CommunityList", "id": "cl1", "display_name": "cl1", "path": "/infra/tier-0s/vmc_prv/community-lists/cl1", "parent_path": "/infra/tier-0s/vmc_prv", "relative_path": "cl1", "communities": [ "NO_EXPORT", "2345:2018" ], "_create_user": "admin", "_create_time": 1516667421694, "_last_modified_user": "admin", "_last_modified_time": 1516667421694, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 } ] }
Required Permissions:
read
Feature:
policy_t0
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable