NSX-T Data Center REST API

Return top 10 flows information

Run flow monitor for timeout seconds for all or certain CPU core(s)
and return top 10 flows.

Request:

Method:
GET
URI Path(s):
/api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
Request Headers:
n/a
Query Parameters:
EdgeDataplaneTopKFlowQueryParameters+
Request Body:
n/a

Example Request:

GET https://<ip>/api/v1/node/services/dataplane/flow-mon?core_id=3&timeout=60 (or) GET https://<ip>/api/v1/node/services/dataplane/flow-mon?core_id=3 (or) GET https://<ip>/api/v1/node/services/dataplane/flow-mon?timeout=60 (or) GET https://<ip>/api/v1/node/services/dataplane/flow-mon

Successful Response:

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

Example Response:

{ "flow_count": 10, "flows": [ { "dst_ip": "192.168.1.11", "dst_port": 6081, "proto": 17, "src_ip": "192.168.1.8", "src_port": 59205, "tunnel_dst_ip": "0.0.0.0", "tunnel_src_ip": "0.0.0.0" }, { "dst_ip": "192.168.1.11", "dst_port": 3784, "proto": 17, "src_ip": "192.168.1.8", "src_port": 49155, "tunnel_dst_ip": "192.168.1.11", "tunnel_src_ip": "192.168.1.8" }, ... ... { "dst_ip": "192.168.1.10", "dst_port": 6081, "proto": 17, "src_ip": "192.168.1.6", "src_port": 52030, "tunnel_dst_ip": "0.0.0.0", "tunnel_src_ip": "0.0.0.0" } ] }

Required Permissions:

read

Feature:

system_administration

Additional Errors: