List all Traceflow rounds

List all Traceflow rounds; if a logical port id is given as a query parameter,
only those originated from the logical port are returned.

Request:

Method:

GET

URI Path(s):

/api/v1/traceflows

Request Headers:

n/a

Query Parameters:

TraceflowListParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
lport_id	id of the source logical port where the trace flows originated	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://<nsx-mgr>/api/v1/traceflows

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TraceflowListResult+

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	Traceflow Results	array of Traceflow	Readonly
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": "logical_port_id", "result_count": 2, "results": [ { "lport_id": "65b9eb3d-0daa-42fc-a17d-15671d3f4ed3", "counters": { "forwarded_count": 2, "delivered_count": 1, "received_count": 3, "dropped_count": 0 }, "logical_counters": { "forwarded_count": 4, "delivered_count": 0, "received_count": 6, "dropped_count": 1 }, "operation_state": "FINISHED", "id": "16799efb-d257-490c-a14c-b59735c30aae", "result_overflowed": false, "timeout": 10000 }, { "lport_id": "e115ed0e-ad27-4a48-a172-353faa544daa", "counters": { "forwarded_count": 0, "delivered_count": 0, "received_count": 0, "dropped_count": 0 }, "logical_counters": { "forwarded_count": 0, "delivered_count": 0, "received_count": 0, "dropped_count": 0 }, "operation_state": "FINISHED", "id": "5b48b93a-6d84-474b-aa78-c32b20ba1be4", "result_overflowed": false, "timeout": 10000 } ] }

List all Traceflow rounds

Request:

TraceflowListParameters (schema)

Example Request:

Successful Response:

TraceflowListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: