Get Live Trace Result

Get Live Trace Result

Get the result of a livetrace session
This API is deprecated. Please use policy API /infra/livetraces//result to get the livetrace session result.

Request
URI
GET
https://nsxmanager.your.domain/api/v1/livetraces/{livetrace-session-id}/results
COPY
Path Parameters
string
livetrace-session-id
Required

livetrace-session-id

Query Parameters
string
action_type
Optional

The type of observations that will be listed.

Possible values are : TRACE, PKTCAP, COUNT, DATAPATH_STATS,
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

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.
Responses
200

OK

Returns LiveTraceResult of type(s) application/json
{
    "counter_results": {
        "backward_results": [
            {
                "resource_type": "string"
            }
        ],
        "forward_results": [
            {
                "resource_type": "string"
            }
        ]
    },
    "datapath_stats_results": [
        {
            "direction": "string",
            "transport_node_datapath_stats": [
                {
                    "datapath_counter_results": [
                        {
                            "module_counters": [
                                {
                                    "counter_name": "string",
                                    "counter_value": 0
                                }
                            ],
                            "module_name": "string"
                        }
                    ],
                    "transport_node_id": "string",
                    "transport_node_name": "string"
                }
            ]
        }
    ],
    "id": "string",
    "pktcap_results": [
        {
            "pktcap_resource_list": [
                {
                    "resource_type": "string",
                    "pktcap_file_download_url": "string",
                    "port_id": "string"
                }
            ],
            "transport_node_id": "string",
            "transport_node_type": "string"
        }
    ],
    "trace_results": [
        {
            "analysis": [
                "string"
            ],
            "counters": {
                "delivered_count": 0,
                "dropped_count": 0,
                "forwarded_count": 0,
                "protected_count": 0,
                "received_count": 0
            },
            "direction": "string",
            "logical_counters": {
                "delivered_count": 0,
                "dropped_count": 0,
                "forwarded_count": 0,
                "protected_count": 0,
                "received_count": 0
            },
            "observations": [
                {
                    "component_name": "string",
                    "component_sub_type": "string",
                    "component_type": "string",
                    "resource_type": "string",
                    "sequence_no": 0,
                    "site_path": "string",
                    "timestamp": 0,
                    "timestamp_micro": 0,
                    "transport_node_id": "string",
                    "transport_node_name": "string",
                    "transport_node_type": "string"
                }
            ],
            "packet_id": "string",
            "result_overflowed": false
        }
    ]
}
object
counter_results
Optional

counter_results

array of object
datapath_stats_results
Optional

The results of the datapath statistics action.

string
id
Optional

The id is assigned by Livetrace and cannot be specified by user.

array of object
pktcap_results
Optional

PktCap action results

array of object
trace_results
Optional

Trace action observation list results


400
Returns BadRequest of type(s) application/json
Operation doesn't return any data structure

403
Returns Forbidden of type(s) application/json
Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/livetraces/{livetrace-session-id}/results
                
Deprecated
Management Plane Api Operations
GET
List Ipfix Collector Upm Profiles
Deprecated
POST
Create Ipfix Collector Upm Profile
Deprecated
DELETE
Delete Ipfix Collector Upm Profile
Deprecated
GET
Get Ipfix Collector Upm Profile
Deprecated
PUT
Update Ipfix Collector Upm Profile
Deprecated
GET
List Ipfix Upm Profiles
Deprecated
POST
Create Ipfix Upm Profile
Deprecated
DELETE
Delete Ipfix Upm Profile
Deprecated
GET
Get Ipfix Upm Profile
Deprecated
PUT
Update Ipfix Upm Profile
Deprecated
GET
List Ipfix Collector Config
Deprecated
POST
Create Ipfix Collector Config
Deprecated
DELETE
Delete Ipfix Collector Config
Deprecated
GET
Get Ipfix Collector Config
Deprecated
PUT
Update Ipfix Collector Config
Deprecated
GET
List Ipfix Config
Deprecated
POST
Create Ipfix Config
Deprecated
DELETE
Delete Ipfix Config
Deprecated
GET
Get Ipfix Config
Deprecated
PUT
Update Ipfix Config
Deprecated
GET
List Live Trace
Deprecated
POST
Create Live Trace
Deprecated
DELETE
Delete Live Trace
Deprecated
GET
Get Live Trace Status
Deprecated
GET
Get Forward Pkt Cap File Proxy
Deprecated
GET
Get Reverse Pkt Cap File Proxy
Deprecated
GET
Get Live Trace Result
Deprecated
GET
Get Forwarding Path
Deprecated
GET
List Manual Health Checks
POST
Create Manual Health Check
DELETE
Delete Manual Health Check
GET
Get Manual Health Check
GET
List Port Mirroring Session
Deprecated
POST
Create Port Mirroring Sessions
Deprecated
DELETE
Delete Port Mirroring Session
Deprecated
GET
Get Port Mirroring Session
Deprecated
PUT
Update Port Mirroring Session
Deprecated
GET
Get Mirror Stack Status
Deprecated
POST
Verify Port Mirroring Session
Deprecated
POST
Create Packet Capture Session
GET
Read Packet Capture Session
GET
Get Capture File
POST
Delete Packet Capture Session
POST
Restart Packet Capture Session
POST
Terminate Packet Capture Session
GET
List Packet Capture Sessions
POST
Delete All Capture Sessions
GET
List Traceflows
Deprecated
POST
Create Traceflow
Deprecated
DELETE
Delete Traceflow
Deprecated
GET
Get Traceflow
Deprecated
GET
Get Traceflow Observations
Deprecated