Developer Documentation
Get L2VPN Session Stats
- no enforcement point path specified: statistics are evaluated on each enforcement point.
- an enforcement point path is specified: statistics are evaluated only on the given enforcement point.
- source=realtime: statistics are fetched realtime from the enforcement point.
- source=cached: cached statistics from the enforcement point are returned.
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/l2vpn-services/{service-id}/sessions/{session-id}/statistics
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | String Path of the enforcement point |
| optional |
|
string | Data source type. |
Response
Response
Response BodyResponse Body
200 OK returns
AggregateL2VPNSessionStatistics
{
"intent_path": "string",
"results": [
{
"alarm": {
"error_details": {
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string",
"related_errors": [
{
"details": "string",
"error_code": 0,
"error_message": "string",
"module_name": "string"
}
]
},
"error_id": "string",
"message": "string"
},
"enforcement_point_path": "string",
"resource_type": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| intent_path | string |
Intent path of object, forward slashes must be escaped using %2F. |
| results | array of L2VPNSessionStatisticsPerEP |
List of L2VPN Session Statistics per Enforcement Point. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | NotFound | The requested resource could not be found but may be available again in the future. |
| 412 | PreconditionFailed | Not available |
| 500 | InternalServerError | The server encountered an unexpected condition which prevented it from fulfilling the request. |
| 503 | ServiceUnavailable | The server is currently unavailable (because it is overloaded or down for maintenance). |
| 400 | BadRequest | The request cannot be fulfilled due to bad syntax. |
| 403 | Forbidden | The server understood the request, but is refusing to fulfill it. |
On This Page
Locale Services L2VPN Operations
put
delete
delete
delete
get
get
get
patch
patch
patch
