Management Plane API >
Troubleshooting And Monitoring
>
Livetrace
List all livetrace sessions
Request:
Method:
GET
URI Path(s):
/api/v1/livetraces
Request Headers:
n/a
Query Parameters:
ListRequestParameters
+
ListRequestParameters
(
schema
)
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
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/livetraces
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LiveTraceListResult
+
LiveTraceListResult
(
schema
)
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
Livetrace status list
array of
LiveTraceStatus
sort_ascending
If true, results are sorted in ascending order
boolean
Readonly
sort_by
Field by which records are sorted
string
Readonly
Example Response:
{ "results": [ { "id": "307", "source_lport": "d4568e3b-326f-48c8-abbd-5b8a557bb43a", "operation_state": "FINISHED", "timeout": 10, "filter": { "ip_info": { "src_ip": "10.185.241.17", "dst_ip": "10.185.243.227" }, "transport_info": {}, "resource_type": "FieldsFilterData" }, "actions": { "count_config": { "action_argument": { "count_type": "ALL" } }, "pktcap_config": { "action_argument": { "pktcap_type": "UNI_DIRECTIONAL", "dest_lport": "836d2e5e-4188-4ef7-ac48-23a6acb8936f" }, "sampling_argument": { "match_number": 2, "sampling_type": "FirstNSampling" } } }, "request_status": "SUCCESS_DELIVERED", "_protection": "NOT_PROTECTED" }, { "id": "308", "source_lport": "d4568e3b-326f-48c8-abbd-5b8a557bb43a", "operation_state": "FINISHED", "timeout": 10, "filter": { "ip_info": { "src_ip": "10.185.241.17", "dst_ip": "10.185.243.227" }, "transport_info": { "protocol": "TCP", "src_port": 16637, "dst_port": 80 }, "resource_type": "FieldsFilterData" }, "actions": { "trace_config": { "action_argument": { "trace_type": "UNI_DIRECTIONAL", "dest_lport": "836d2e5e-4188-4ef7-ac48-23a6acb8936f" }, "sampling_argument": { "match_number": 2, "sampling_type": "FirstNSampling" } }, "count_config": { "action_argument": { "count_type": "ALL" } }, "pktcap_config": { "action_argument": { "pktcap_type": "UNI_DIRECTIONAL", "dest_lport": "836d2e5e-4188-4ef7-ac48-23a6acb8936f" }, "sampling_argument": { "match_number": 2, "sampling_type": "FirstNSampling" } } }, "request_status": "SUCCESS_DELIVERED", "_protection": "NOT_PROTECTED" } ], "result_count": 2, "sort_by": "source_logical_port", "sort_ascending": true }
Required Permissions:
read
Feature:
tools_livetrace
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable