GET: Saved Trace Summary
The NetMaster GET: Saved Trace Summary API endpoint retrieves a list of all saved SmartTraces in a specified region.
The GET: Saved Trace Summary API retrieves a list of all saved SmartTraces in a specified region.
The following reference article includes:
- Uniform Resource Identifier (URI) Parameters
- Query Parameters
- Response Format
- Interface Properties
- Status Codes
- Sample Requests and Responses
URI Parameters
The URI for Get Saved Trace Summary is:
GET /api/v1/tcpip/{region}/smart/saved
Use the
Region
URI parameter to identify the NetMaster region from which you are requesting data.Query Parameters
Use the following optional query parameters to filter the returned data:
Parameter | Data Type | Default | Description |
index | Integer | 0 | Start position (zero-based row number) of the data to return |
limit | Integer | 0 | Limit (maximum number of rows) on the data to return |
Response Format
Returned tabular data for the summary list of saved SmartTraces appears in the following format:
{ "apiVersion": "v1", "data": { "index": 0, "keys": [ "string" ], "rows": [ { "definitionName": "string", "id": "string", "name": "string", "packetCount": { "saved": 250, "total": 178592 }, "stack": "string", "timestamps": { "first": 1631817818000, "last": 1631817819000, "saved": 1631817820000 }, "user": "string" } ], "totalRows": 10 }, "swaggerVersion": "2.0", "time": 1564754568891 }
Interface Properties
The following table describes the properties of the returned data for the saved SmartTraces:
Property Name | Data Type | Description |
ID | String | A unique identifier for the saved trace instance, in the format {definitionName}-{trace #} |
name | String | The name of the saved SmartTrace |
definitionName | String | The name of the SmartTrace definition associated with the saved trace |
packetCount | n/a | Packet count information for the trace |
saved | Integer | The total number of packets saved |
total | Integer | The total number of packets traced |
stack | String | The TCP/IP stack on which the trace was saved |
timestamps | n/a | Timestamp values for the trace |
first | Integer | The time in milliseconds when the first packet in the trace was captured, displayed in Universal Time Coordinated (UTC) time |
last | Integer | The time in milliseconds when the last packet in the trace was captured, displayed in UTC time. |
saved | Integer | The time in milliseconds when the trace was saved, displayed in UTC time |
user | string | The user that saved the trace. |
Additional Properties:
Property Name | Data Type | Description |
totalRows | Integer | The total number of rows of available data |
swaggerVersion | Integer | The Swagger version |
time | Integer | The time in milliseconds, displayed in UTC time, when the response was generated |
Status Codes
The following status codes can appear in the response to GET: Saved Trace Summary:
- 200 OK- A list of saved traces was returned back to the client.
- 400 Bad Request- A list of traces could not be returned due to one of the following conditions:
- Invalid format for the URI parameters
- Invalid format for the Query parameters
- 401 Unauthorized- The user is not authenticated to the application. They must provide either a valid login token or valid credentials before continuing.
- 403 Forbidden- A list of traces could not be found because the user does not have the appropriate authority to view traces.
- 500- Server error
Sample Requests and Responses
Request:
The following is a saved trace request, with a limit of two rows:
GET /api/v1/tcpip/U11NDE81/smart/saved?limit=2
Response:
{ "apiVersion": "v1", "data": { "index": 0, "keys": ["id"], "rows": [ { "id": "CWTCPCOPY-1", "name": "Saved Trace 1", "definitionName": "CWTCPCOPY", "packetCount": { "saved": 250, "total": 12347 }, "stack": "TCPIP11", "timestamps": { "first": 1564754500000, "last": 1564754560000, "saved": 1564754560000 }, "user": "WRICH04" }, { "id": "CWTCPCOPY-2", "name": "Saved Trace 2", "definitionName": "CWTCPCOPY", "packetCount": { "saved": 250, "total": 12347 }, "stack": "TCPIP11", "timestamps": { "first": 1564754500000, "last": 1564754750000, "saved": 1564754760000 }, "user": "WRICH04" } ], "totalRows": 50 }, "swaggerVersion": "2", "time": 1564754568891 }