Get L2 Vpn Tunnel Statistics

Get L2 Vpn Tunnel Statistics

Retrieves connection statistics for a given L2 VPN Tunnel configured on an Edge Gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/metrics
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeL2VpnTunnelStatistics of type(s) application/json;version=38.1 
{
    "bumBytesIn": 0,
    "bumBytesOut": 0,
    "bumPacketsIn": 0,
    "bumPacketsOut": 0,
    "bytesIn": 0,
    "bytesOut": 0,
    "packetsIn": 0,
    "packetsOut": 0,
    "packetsReceiveError": 0,
    "packetsSentError": 0,
    "segmentPath": "string"
}
integer As int64 As int64
bumBytesIn
Optional

Broadcast, Unknown unicast, and Multicast (BUM) bytes in.

integer As int64 As int64
bumBytesOut
Optional

Broadcast, Unknown unicast, and Multicast (BUM) bytes out.

integer As int64 As int64
bumPacketsIn
Optional

Broadcast, Unknown unicast, and Multicast (BUM) packets in.

integer As int64 As int64
bumPacketsOut
Optional

Broadcast, Unknown unicast, and Multicast (BUM) packets out.

integer As int64 As int64
bytesIn
Optional

Total number of incoming bytes.

integer As int64 As int64
bytesOut
Optional

Total number of outgoing bytes.

integer As int64 As int64
packetsIn
Optional

Total number of incoming packets.

integer As int64 As int64
packetsOut
Optional

Total number of outgoing packets.

integer As int64 As int64
packetsReceiveError
Optional

Total number of incoming packets dropped.

integer As int64 As int64
packetsSentError
Optional

Total number of packets dropped while sending for any reason.

string
segmentPath
Optional

Policy path referencing the segment on which stats are gathered.


404

The specified resource was not found

Returns Error of type(s) application/json;version=38.1 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 35.0
On This Page
Edge Gateway L2vpn Tunnel Operations
DELETE
Delete L2 Vpn Tunnel
GET
Get L2 Vpn Tunnel
GET
Get L2 Vpn Tunnel Statistics
GET
Get L2 Vpn Tunnel Status
PUT
Update L2 Vpn Tunnel