Skip to content
API Enriched

Show Matching Flows.

POST
/api/operate/namespaces/{namespace}/sites/{site}/ver/matching_flows
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/operate/namespaces/example/sites/example/ver/matching_flows \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dest": "example", "dest_port": 1, "external_service": {}, "intf": "example", "namespace": "example", "node": "example", "pod": "example", "proto": 1, "seconds": 1, "site": "example", "src": "example", "src_port": 1, "vn": "example", "vn_type": "VIRTUAL_NETWORK_SITE_LOCAL" }'

Show VER flows matching the request.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace for which the request is sent (system)

site
required
string

Site Name Name of the site from which flows are requested.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Flow Match Request

Request to GET list of VER flows matching the request.

object
dest
Destination Address

Destination Address of the flow (optional)

string
<= 1024 characters
dest_port
Destination Port

Destination port of the flow (optional)

integer format: int64
external_service
object
intf
Interface

Exclusive with [external_service pod vn vn_type] Name of the Interface on which flows are to be matched.

string
<= 1024 characters
namespace
Namespace

Namespace for which the request is sent (system)

string
>= 6 characters <= 1024 characters
node
Node Name

Name of the node from which flows are requested.

string
>= 1 characters <= 64 characters
pod
Pod Name

Exclusive with [external_service intf vn vn_type] Name of the pod for which flows are to be matched.

string
<= 1024 characters
proto
Protocol

Protocol of the flow (optional)

integer format: int64
seconds
Seconds

Number of seconds for which flows are requested. A value of 100 returns flows created in the past 100 seconds, with a maximum of 1024 flows. A value of 0 returns all matching flows upto a maximum of 1024.

integer format: int64
site
Site Name

Name of the site from which flows are requested.

string
<= 1024 characters
src
Source Address

Source Address of the flow (optional)

string
<= 1024 characters
src_port
Source Port

Source port of the flow (optional)

integer format: int64
vn
Virtual Network

Exclusive with [external_service intf pod vn_type] Name of Virtual Network on which flows are matched.

string
<= 1024 characters
vn_type
string
default: VIRTUAL_NETWORK_SITE_LOCAL
Allowed values: VIRTUAL_NETWORK_SITE_LOCAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE VIRTUAL_NETWORK_PER_SITE VIRTUAL_NETWORK_PUBLIC VIRTUAL_NETWORK_GLOBAL VIRTUAL_NETWORK_SITE_SERVICE VIRTUAL_NETWORK_VER_INTERNAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE VIRTUAL_NETWORK_IP_AUTO VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK VIRTUAL_NETWORK_SRV6_NETWORK VIRTUAL_NETWORK_IP_FABRIC VIRTUAL_NETWORK_SEGMENT VIRTUAL_NETWORK_MANAGEMENT

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Flows

Matching flow list from VER.

object
flow
Flow Info

Flow information.

Array<object>
Flow Information

Flow information.

object
ace_id
Ace

ACE identifier.

integer format: int64
acl_id
Acl

ACL identifier.

integer format: int64
action
Flow Action

Action on the flow traffic.

string
<= 1024 characters
byte_count
Byte Count

Total byte count of the packets that hit the flow.

string format: uint64
<= 1024 characters
dest_nh_id
Destination Nexthop

Destination nexthop ID.

integer format: int64
dest_vrf_id
Dest VRF

Destination VRF ID, when VRF translation is involved.

integer format: int64
drop_reason
Drop Reason

Reason for flow drop, when action is “Drop”

string
<= 1024 characters
ecmp_nh_id
Ecmp Nexthop

List of nexthop identifiers, when ecmp is applicable.

Array<integer>
external_service_nh_id
External Service Nexthop

Nexthop for the External Service.

integer format: int64
flags
Flags

Flow TCP flags.

string
<= 1024 characters
flow_index
Flow Index

Index of the forward flow.

integer format: int64
forward_flow
object
dest
Destination Address

Destination Address of the flow.

string
<= 1024 characters
dest_port
Destination Port

Destination port of the flow.

integer format: int32
intf_id
Interface Index

Interface index.

integer format: int64
proto
Protocol

Protocol of the flow.

integer format: int64
src
Source Address

Source Address of the flow.

string
<= 1024 characters
src_port
Source Port

Source port of the flow.

integer format: int64
vrf_id
Vrf

Vrf index

integer format: int64
forward_label
Forward Label

Forward label.

integer format: int32
fr_ttl
Ttl

TTL value

integer format: int64
pkt_count
Packet Count

Number of packets that hit the flow.

string format: uint64
<= 1024 characters
qos_id
Qos

QoS identifier.

integer format: int64
reverse_flow_index
Reverse Flow Index

Index of the reverse flow.

integer format: int64
src_nh_id
Source Nexthop

Source nexthop ID.

integer format: int64
Examplegenerated
{
  "flow": [
    {
      "ace_id": 1,
      "acl_id": 1,
      "action": "example",
      "byte_count": "example",
      "dest_nh_id": 1,
      "dest_vrf_id": 1,
      "drop_reason": "example",
      "ecmp_nh_id": [
        1
      ],
      "external_service_nh_id": 1,
      "flags": "example",
      "flow_index": 1,
      "forward_flow": {
        "dest": "example",
        "dest_port": 1,
        "intf_id": 1,
        "proto": 1,
        "src": "example",
        "src_port": 1,
        "vrf_id": 1
      },
      "forward_label": 1,
      "fr_ttl": 1,
      "pkt_count": "example",
      "qos_id": 1,
      "reverse_flow_index": 1,
      "src_nh_id": 1
    }
  ]
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example