Management Plane API > Networking > Services > Policy Based Routing

Get an Existing Section, Including Rules

Returns PBR section information with rules for a section identifier.
When invoked on a section with a large number of rules, this API is supported
only at low rates of invocation (not more than 4-5 times per minute). The
typical latency of this API with about 1024 rules is about 4-5 seconds. This
API should not be invoked with large payloads at automation speeds. More than
50 rules with a large number rule references is not supported.

Instead, to read PBR rules, use:
GET /api/v1/pbr/sections/<section-id>/rules with the appropriate
page_size.

Request:

Method:
POST
URI Path(s):
/api/v1/pbr/sections/<section-id>?action=list_with_rules
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/pbr/sections/65a60890-6f48-418d-a7d5-5aaf65fc4e5b?action=list_with_rules

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PBRSectionRuleList+

Example Response:

{ "resource_type": "PBRSectionRuleList", "id": "65a60890-6f48-418d-a7d5-5aaf65fc4e5b", "display_name": "DS-PBR-vpc-5b4cf63d", "rule_count": 1, "rules": [ { "id": "1430528", "display_name": "PBR-RDS-vpc-5b4cf63d", "destinations": [ { "target_display_name": "RDS-vpc-5b4cf63d", "is_valid": true, "target_type": "IPSet", "target_id": "96ebbc9f-6eae-4009-b709-532820dbba2a" } ], "logged": false, "action": "ROUTE_TO_UNDERLAY_NAT", "disabled": false, "_revision": 1 } ], "_last_modified_user": "system", "_last_modified_time": 1445912484450, "_revision": 1 }

Required Permissions:

read

Feature:

pbr

Additional Errors: