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+

Name	Description	Type	Notes
core_id	CPU core on which the flows are to be monitored CPU core on which the flows are to be monitored	integer	Minimum: 0 Maximum: 128
fields	Fields to include in query results Comma-separated field names to include in query result	string
timeout	Timeout for flow monitor in seconds Timeout for flow monitor in seconds	integer	Minimum: 1 Maximum: 120 Default: "30"

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+

Name	Description	Type	Notes
flow_count	Count of flow records Count of flow records in the result	integer
flows	Array of flow records Array of flow records	array of EdgeDataplaneFlow

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" } ] }

Return top 10 flows information

Request:

EdgeDataplaneTopKFlowQueryParameters (schema)

Example Request:

Successful Response:

EdgeDataplaneTopKFlows (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: