Get L2VPN Session Statistics

Get statistics of a L2VPN session. Query parameter source=realtime is the only supported source.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/vpn/l2vpn/sessions/{session-id}/statistics

COPY

Path Parameters

string

session-id

Required

session-id

Query Parameters

string

source

Optional

Data source type.

Possible values are : realtime, cached,

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns L2VPNSessionStatistics of type(s) application/json

{
    "traffic_statistics_per_logical_switch": [
        {
            "packets_out": 0,
            "packets_receive_error": 0,
            "bytes_in": 0,
            "bum_packets_in": 0,
            "bum_bytes_out": 0,
            "logical_switch": {
                "target_display_name": "string",
                "is_valid": false,
                "target_id": "string",
                "target_type": "string"
            },
            "bytes_out": 0,
            "packets_sent_error": 0,
            "bum_packets_out": 0,
            "packets_in": 0,
            "bum_bytes_in": 0
        }
    ],
    "display_name": "string",
    "partial_stats": false,
    "session_id": "string",
    "tap_traffic_counters": [
        {
            "packets_out": 0,
            "bytes_in": 0,
            "packets_sent_error": 0,
            "packets_receive_error": 0,
            "packets_in": 0,
            "bytes_out": 0
        }
    ]
}

array of L2VPNPerLSTrafficStatistics

traffic_statistics_per_logical_switch

Optional

Traffic statistics per logical switch.

string

display_name

Optional

L2VPN display name.

boolean

partial_stats

Optional

Partial statistics is set to true if onle active node responds while standby does not. In case of both nodes responded statistics will be summed and partial stats will be false. If cluster has only active node, partial statistics will always be false.

string

session_id

Optional

Session identifier for L2VPN.

array of L2VPNTapTrafficStatistics

tap_traffic_counters

Optional

Tunnel port traffic counters.

400

Returns BadRequest of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

403

Returns Forbidden of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

404

Returns NotFound of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

412

Returns PreconditionFailed of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

500

Returns InternalServerError of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error

string

module_name

Optional

The module name where the error occurred

string

error_message

Optional

A description of the error

integer As int64 As int64

error_code

Optional

A numeric error code

503

Returns ServiceUnavailable of type(s) application/json

{
    "details": "string",
    "related_errors": [
        "ApiError Object"
    ],
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

object

error_data

Optional

Additional data about the error

string

details

Optional

Further details about the error

array of ApiError

related_errors

Optional

Other errors related to this error