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+

PBRSectionRuleList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Unique identifier of this resource	string	Sortable
resource_type	Must be set to the value PBRSectionRuleList	string
rule_count	Rule count Number of rules in this section.	integer	Readonly
rules	List of the PBR rules List of PBR rules in the section.	array of PBRRule	Required Maximum items: 1000
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

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 }

Get an Existing Section, Including Rules

Request:

Example Request:

Successful Response:

PBRSectionRuleList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: