Skip to main content

Get Flow Information (v3.4)​

List all the flow information.

Request Body

Filter for flows

  • debug_level string required

    Possible values: [summary, tcp-flags, traffic, all]

    The values of the debug levels.

  • end_time date required

    The end time to get the flows information.

  • filter FlowsFilter required

    Filters according to the specifications.

  • app string[] required

    App

  • element string[] required

    Element

  • flow FlowTupple required

    Flow

  • destination_ip string[] required

    Destination Ip

  • destination_port integer[] required

    Destination Port

  • protocol integer required

    Protocol

  • source_ip string[] required

    Source Ip

  • source_port integer[] required

    Source Port

  • flow_type string required

    Possible values: [local, wan, all]

    Flow Type

  • path string[] required

    Path

  • path_type string[] required

    Possible values: [public_direct, public_vpn, private_direct, private_vpn, unknown, servicelink]

    Path Type

  • security_policy_destination_zone string[] required

    Security Policy Destination Zone

  • security_policy_rule string[] required

    Security Policy Rule

  • security_policy_rule_action string required

    Possible values: [allow, deny, reject]

    Security Policy Rule Action

  • security_policy_source_zone string[] required

    Security Policy Source Zone

  • site string[] required

    Site

  • waninterface string[] required

    Waninterface

  • max_datapoints integer required

    The max data points.

  • name string required

    The description of the flow. Maz size = 128.

  • start_time date required

    The start time to get the flow information.

Responses

Successful Operation

Schema
  • flows Flows required

    Flows

  • debug_level string required

    Debug Level

  • end_time string required

    End Time

  • items FlowDetails[] required

    Items

  • Array [
  • app_id string required

    App Id

  • average_ntt float required

    Average Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • average_pg float required

    Average Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • average_rtt float required

    Average Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • average_srt float required

    Average Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • average_udp_trt float required

    Average Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_jitter_c2s float required

    Avg Jitter C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_jitter_s2c float required

    Avg Jitter S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_mos_c2s float required

    Avg Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_mos_s2c float required

    Avg Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_packet_loss_c2s float required

    Avg Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • avg_packet_loss_s2c float required

    Avg Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • bytes_c2s int64 required

    Bytes C2s

  • bytes_s2c int64 required

    Bytes S2c

  • codec_c2s int64[] required

    Codec C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • codec_s2c int64[] required

    Codec S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • destination_ip string required

    Destination Ip

  • destination_lan_network_id string required

    Destination Lan Network Id

  • destination_lan_vlan_id integer required

    Destination Lan Vlan Id

  • destination_port integer required

    Destination Port

  • element_id string required

    Element Id

  • fc_app_id string required

    Fc App Id

  • fin_c2s int64 required

    Fin C2s

  • fin_s2c int64 required

    Fin S2c

  • flow_action string required

    Flow Action

  • flow_decision_metadata_list FlowDecisionMetadata[] required

    Flow Decision Metadata List

  • Array [
  • available_wan_networks string[] required

    Available Wan Networks: JsonAlias(value = [bw_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • chosen_wan_path string required

    Chosen Wan Path: JsonAlias(value = [path_id])

  • flow_decision_bitmap int64[] required

    Flow Decision Bitmap: JsonAlias(value = [bitmap]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • flow_decision_time int64 required

    Flow Decision Time: JsonAlias(value = [time])

  • policy_allowed_wan_paths string[] required

    Policy Allowed Wan Paths: JsonAlias(value = [policy_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • predictive_wan_network_normalized_load string[] required

    Predictive Wan Network Normalized Load: JsonAlias(value = [bw_values]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • preferred_wan_path string required

    Preferred Wan Path: JsonAlias(value = [pref_wan_path]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • sla_filtered_state_up_policy_allowed_wan_paths string[] required

    Sla Filtered State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_sla_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • state_up_policy_allowed_wan_paths string[] required

    State Up Policy Allowed Wan Paths: JsonAlias(value = [policy_l2l3_paths]) JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • ]
  • flow_end_time_ms int64 required

    Flow End Time Ms

  • flow_start_time_ms int64 required

    Flow Start Time Ms

  • incomplete_trans int64 required

    Incomplete Trans: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • init_success boolean required

    Init Success: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • is_local_traffic boolean required

    Is Local Traffic

  • is_sec_policy_present boolean required

    Is Sec Policy Present

  • lan_dscp_lan_to_wan integer[] required

    Lan Dscp Lan To Wan: JsonDeserialize(as = classOf[Void], builder = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using = classOf[CustomGetSetPositionsDeserializer])

  • lan_dscp_wan_to_lan integer[] required

    Lan Dscp Wan To Lan: JsonDeserialize(as = classOf[Void], builder = classOf[Void], contentAs = classOf[Void], contentConverter = classOf[Converter$None], contentUsing = classOf[JsonDeserializer$None], converter = classOf[Converter$None], keyAs = classOf[Void], keyUsing = classOf[KeyDeserializer$None], using = classOf[CustomGetSetPositionsDeserializer])

  • lan_origination_id string required

    Lan Origination Id

  • lan_termination_id string required

    Lan Termination Id

  • lan_to_wan boolean required

    Lan To Wan

  • max_jitter_c2s float required

    Max Jitter C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_jitter_s2c float required

    Max Jitter S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_mos_c2s float required

    Max Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_mos_s2c float required

    Max Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_ntt float required

    Max Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_packet_loss_c2s float required

    Max Packet Loss C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_packet_loss_s2c float required

    Max Packet Loss S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_pg float required

    Max Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_rtt float required

    Max Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_srt float required

    Max Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • max_udp_trt float required

    Max Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • media_type string required

    Media Type: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_mos_c2s float required

    Min Mos C2s: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_mos_s2c float required

    Min Mos S2c: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_ntt float required

    Min Ntt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_pg float required

    Min Pg: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_rtt float required

    Min Rtt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_srt float required

    Min Srt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • min_udp_trt float required

    Min Udp Trt: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • network_policy_dst_prefix_id string required

    Network Policy Dst Prefix Id

  • network_policy_id string required

    Network Policy Id

  • network_policy_nctx_id string required

    Network Policy Nctx Id

  • network_policy_set_id string required

    Network Policy Set Id

  • network_policy_src_prefix_id string required

    Network Policy Src Prefix Id

  • network_policy_stack_id string required

    Network Policy Stack Id

  • new_flow boolean required

    New Flow

  • ooo_pkts_c2s int64 required

    Ooo Pkts C2s

  • ooo_pkts_s2c int64 required

    Ooo Pkts S2c

  • packets_c2s int64 required

    Packets C2s

  • packets_s2c int64 required

    Packets S2c

  • path_id string required

    Path Id

  • path_type string required

    Path Type

  • policy_id string required

    Policy Id

  • priority_class integer required

    Priority Class: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • priority_policy_default_rule_mapping_incoming_dscp int64 required

    Priority Policy Default Rule Mapping Incoming Dscp

  • priority_policy_dst_prefix_id string required

    Priority Policy Dst Prefix Id

  • priority_policy_id string required

    Priority Policy Id

  • priority_policy_nctx_id string required

    Priority Policy Nctx Id

  • priority_policy_remark_dscp int64 required

    Priority Policy Remark Dscp

  • priority_policy_set_id string required

    Priority Policy Set Id

  • priority_policy_src_prefix_id string required

    Priority Policy Src Prefix Id

  • priority_policy_stack_id string required

    Priority Policy Stack Id

  • protocol integer required

    Protocol

  • reset_c2s int64 required

    Reset C2s

  • reset_s2c int64 required

    Reset S2c

  • retransmit_bytes_c2s int64 required

    Retransmit Bytes C2s

  • retransmit_bytes_s2c int64 required

    Retransmit Bytes S2c

  • retransmit_pkts_c2s int64 required

    Retransmit Pkts C2s

  • retransmit_pkts_s2c int64 required

    Retransmit Pkts S2c

  • sack_pkts_c2s int64 required

    Sack Pkts C2s

  • sack_pkts_s2c int64 required

    Sack Pkts S2c

  • sec_fc_app_id string[] required

    Sec Fc App Id

  • security_policy_rules SecurityPolicyRules[] required

    Security Policy Rules: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = NON_EMPTY, valueFilter = classOf[Void])

  • Array [
  • bytes_c2s int64 required
  • bytes_s2c int64 required
  • packets_c2s int64 required
  • packets_s2c int64 required
  • security_destination_zone_id string required

    Security Destination Zone Id: JsonAlias(value = [dst_zone_id])

  • security_policy_rule_action string required

    Security Policy Rule Action: JsonAlias(value = [action])

  • security_policy_rule_id string required

    Security Policy Rule Id: JsonAlias(value = [rule_id])

  • security_source_zone_id string required

    Security Source Zone Id: JsonAlias(value = [src_zone_id])

  • time int64 required

    Time

  • ]
  • service_endpoint_id string required

    Service Endpoint Id: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • source_ip string required

    Source Ip

  • source_lan_network_id string required

    Source Lan Network Id

  • source_lan_vlan_id integer required

    Source Lan Vlan Id

  • source_port integer required

    Source Port

  • success_transactions int64 required

    Success Transactions: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • syn_c2s int64 required

    Syn C2s

  • syn_s2c int64 required

    Syn S2c

  • traffic_type string required

    Traffic Type: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • unknown_domain string required

    Unknown Domain

  • unknown_reason string required

    Unknown Reason

  • vlan_id integer required

    Vlan Id

  • wan_path_change_reason string required

    Wan Path Change Reason: JsonInclude(content = ALWAYS, contentFilter = classOf[Void], value = ALWAYS, valueFilter = classOf[Void])

  • waninterface_id string required

    Waninterface Id

  • win_scaler_c2s int64 required

    Win Scaler C2s

  • win_scaler_s2c int64 required

    Win Scaler S2c

  • win_size_c2s int64 required

    Win Size C2s

  • win_size_s2c int64 required

    Win Size S2c

  • ]
  • start_time string required

    Start Time

Loading...