{"type":"api","title":"Get Event Readout By Traces","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get event Readout By Traces","operationId":"getEventReadoutByTraces","parameters":[{"name":"trace_id","in":"query","description":"traceId","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"entry_time","in":"query","description":"entry_time","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"vpn","in":"query","description":"vpn","schema":{"type":"string"}},{"name":"userName","in":"query","description":"userName","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"string"},"app_grp":{"type":"string"},"app_vis":{"type":"string"},"art_vis":{"type":"string"},"common_app":{"type":"string"},"detail":{"type":"array","items":{"type":"object","properties":{"application":{"type":"string"},"dropSendPkts":{"type":"array","items":{"type":"object","properties":{"dropPkts":{"type":"integer","format":"int32"},"event":{"type":"string"},"sendPkts":{"type":"integer","format":"int32"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadDropSendPkts"}},"eventHopPolicyInfo":{"type":"array","items":{"type":"object","properties":{"eventHop":{"type":"string"},"eventHopWithEdge":{"type":"string"},"timeInfo":{"type":"array","items":{"type":"object","properties":{"endTime":{"type":"string"},"eventNum":{"type":"string"},"startTime":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadTimeInfo"}}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventHopStatistics":{"type":"array","items":{"type":"object","properties":{"event":{"type":"string"},"hopStatistics":{"type":"array","items":{"type":"object","properties":{"dropCauses":{"type":"array","items":{"type":"object","properties":{"dropCause":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadDropCauses"}},"eventNum":{"type":"string"},"hop":{"type":"string"},"hopWithEdge":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadHopStatistics"}}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopStatistics"}},"eventHopTimeInfo":{"type":"array","items":{"type":"object","properties":{"eventHop":{"type":"string"},"eventHopWithEdge":{"type":"string"},"timeInfo":{"type":"array","items":{"type":"object","properties":{"endTime":{"type":"string"},"eventNum":{"type":"string"},"startTime":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadTimeInfo"}}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadEventHopTimeInfo"}},"eventImpactedFlowNum":{"type":"array","items":{"type":"object","properties":{"event":{"type":"string"},"impactedFlowNum":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadEventImpactedFlowNum"}},"eventList":{"type":"array","items":{"type":"string"}},"eventNum":{"type":"array","items":{"type":"object","properties":{"event":{"type":"string"},"eventNum":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadEventNum"}},"totalFlowNum":{"type":"integer","format":"int32"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadDetail"}},"device_ip":{"type":"string"},"dia_vis":{"type":"string"},"domain_mon":{"type":"string"},"dscp":{"type":"string"},"dst_ip":{"type":"string"},"dst_pfx":{"type":"string"},"dst_pfx_len":{"type":"string"},"dst_port":{"type":"string"},"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"hub_wan_vis":{"type":"string"},"local_drop_rate_threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos_mon":{"type":"string"},"sampling":{"type":"string"},"source_site":{"type":"string"},"source_site_vmanage_version":{"type":"string"},"spl_intvl":{"type":"string"},"src_if":{"type":"string"},"src_ip":{"type":"string"},"src_pfx":{"type":"string"},"src_pfx_len":{"type":"string"},"src_port":{"type":"string"},"state":{"type":"string"},"stop_time":{"type":"integer","format":"int64"},"trace_id":{"type":"integer","format":"int32"},"trace_name":{"type":"string"},"vpn_id":{"type":"string"},"wan_drop_rate_threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}},"$$ref":"#/components/schemas/EventReadoutsResponsePayloadData"},"examples":{"Get event Readout By Traces":{"description":"Get event Readout By Traces","value":{"data":[{"trace_id":160,"entry_time":1673499964222,"source_site":"500","device_ip":"N/A","vpn_id":"1","src_if":"N/A","src_ip":"N/A","src_port":"N/A","dst_ip":"N/A","dst_port":"N/A","src_pfx":"N/A","src_pfx_len":"N/A","dst_pfx":"N/A","dst_pfx_len":"N/A","app":"N/A","common_app":"N/A","app_grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace_name":"dd_test_0112_1","domain_mon":"disabled","qos_mon":"true","art_vis":"true","app_vis":"true","dia_vis":"N/A","hub_wan_vis":"true","sampling":"N/A","spl_intvl":"N/A","stop_time":1673503629842,"source_site_vmanage_version":"20.11.999-2486","state":"stopped","message":"Trace Stop successfully (auto stop)","warning":"","wan_drop_rate_threshold":5,"local_drop_rate_threshold":5,"detail":[{"application":"rtp-video","totalFlowNum":35,"dropSendPkts":[{"sendPkts":5485,"dropPkts":2072,"event":"LOCAL_DROP"}],"eventList":["FIF_DPI_NOT_CLASSIFIED","LOCAL_DROP"],"eventImpactedFlowNum":[{"event":"LOCAL_DROP","impactedFlowNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","impactedFlowNum":"8"}],"eventNum":[{"event":"LOCAL_DROP","eventNum":"13"},{"event":"FIF_DPI_NOT_CLASSIFIED","eventNum":"8"}],"eventHopStatistics":[{"event":"LOCAL_DROP","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"13","dropCauses":[{"dropCause":"MplsFragReq"}]}]},{"event":"FIF_DPI_NOT_CLASSIFIED","hopStatistics":[{"hop":"172.16.255.15:LTE--->172.16.255.16:LTE","hopWithEdge":"diding1_cedge1:LTE--->diding1_cedge2:LTE","eventNum":"8","dropCauses":[]}]}],"eventHopTimeInfo":[{"eventHop":"FIF_DPI_NOT_CLASSIFIED+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"FIF_DPI_NOT_CLASSIFIED+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673499975847","endTime":"1673500050669","eventNum":"8"}]},{"eventHop":"LOCAL_DROP+172.16.255.15:LTE--->172.16.255.16:LTE","eventHopWithEdge":"LOCAL_DROP+diding1_cedge1:LTE--->diding1_cedge2:LTE","timeInfo":[{"startTime":"1673500035854","endTime":"1673500053871","eventNum":"12"},{"startTime":"1673500032732","endTime":"1673500035864","eventNum":"2"}]}],"eventHopPolicyInfo":[]}]}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"__originalOperationId":"getEventReadoutByTraces","method":"get","path":"/stream/device/nwpi/eventReadoutByTraces"}}