List Traceflows

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

This API is deprecated. Please use policy API /infra/traceflows to list all traceflows.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/traceflows

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

string

included_fields

Optional

Comma separated list of fields that should be included in query result

string

lport_id

Optional

id of the source logical port where the trace flows originated

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns TraceflowListResult of type(s) application/json

This response body class contains all of the following: InlineTraceflowListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "analysis": [
                "string"
            ],
            "counters": {
                "delivered_count": 0,
                "dropped_count": 0,
                "forwarded_count": 0,
                "protected_count": 0,
                "received_count": 0
            },
            "logical_counters": {
                "delivered_count": 0,
                "dropped_count": 0,
                "forwarded_count": 0,
                "protected_count": 0,
                "received_count": 0
            },
            "lport_id": "string",
            "operation_state": "string",
            "request_status": "string",
            "result_overflowed": false,
            "timeout": 0
        }
    ]
}

400

Returns BadRequest of type(s) application/json