{"type":"api","title":"Active Flow With Query","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 active flows for NWPI.","operationId":"activeFlowWithQuery","parameters":[{"name":"traceId","in":"query","description":"trace id","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"timestamp","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"query","in":"query","description":"Query filter","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"app_group":{"type":"string"},"app_name":{"type":"string"},"appqoe_diverted":{"type":"boolean"},"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"big_drop":{"type":"boolean"},"big_wan_drop":{"type":"boolean"},"device_trace_id":{"type":"integer","format":"int32"},"domain":{"type":"array","items":{"type":"string"}},"domain_name":{"type":"string"},"domain_src":{"type":"string"},"downstream_device_list":{"type":"array","items":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"localColor":{"type":"string"},"remoteColor":{"type":"string"}},"$$ref":"#/components/schemas/FlowInfoResponseDataDownstreamDeviceList"}},"downstream_dscp":{"type":"string"},"downstream_hop_list":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"},"fif_dpi_not_classified":{"type":"boolean"}},"$$ref":"#/components/schemas/FlowInfoResponseDataDownstreamHopList"},"dpi_policy_used":{"type":"boolean"},"dst_ip":{"type":"string"},"dst_port":{"type":"integer","format":"int32"},"dst_sgt":{"type":"string"},"fif_dpi_not_classified":{"type":"boolean"},"flow_fin":{"type":"boolean"},"flow_id":{"type":"integer","format":"int32"},"flow_key":{"type":"string"},"flow_moved":{"type":"boolean"},"flow_readout":{"type":"object"},"max_local_drop_rate":{"type":"integer","format":"int32"},"max_wan_drop_rate":{"type":"integer","format":"int32"},"nat_translated":{"type":"boolean"},"path_changed":{"type":"boolean"},"policy_bypassed":{"type":"boolean"},"protocol":{"type":"string"},"qos_congested":{"type":"boolean"},"received_timestamp":{"type":"integer","format":"int64"},"server_no_response":{"type":"boolean"},"sla_violated":{"type":"boolean"},"sla_violated_bfd":{"type":"boolean"},"src_ip":{"type":"string"},"src_port":{"type":"integer","format":"int32"},"src_sgt":{"type":"string"},"start_device":{"type":"string"},"start_timestamp":{"type":"integer","format":"int64"},"tcp_flow_reset":{"type":"boolean"},"timestamp":{"type":"integer","format":"int64"},"upstream_device_list":{"type":"array","items":{"type":"object","properties":{"device_name":{"type":"string"},"device_system_ip":{"type":"string"},"ingress_pre_invalid":{"type":"boolean"}},"$$ref":"#/components/schemas/FlowInfoResponseDataUpstreamDeviceList"}},"upstream_dscp":{"type":"string"},"upstream_hop_list":{"type":"array","items":{"type":"object","properties":{"art":{"type":"string"},"asymmetry_detected":{"type":"boolean"},"dpi_policy_used":{"type":"boolean"}},"$$ref":"#/components/schemas/FlowInfoResponseDataUpstreamHopList"}},"utd_diverted":{"type":"boolean"},"vpn_id":{"type":"string"},"wan_color_asym":{"type":"boolean"}},"$$ref":"#/components/schemas/FlowInfoResponseData"}}},"description":"Active flows data response payload","$$ref":"#/components/schemas/ActiveFlowResponsePayload"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"deprecated":true,"x-roles-required":"Device Monitoring-read,Device Monitoring-write","__originalOperationId":"activeFlowWithQuery","method":"get","path":"/stream/device/nwpi/activeFlowWithQuery"}}