mpls_queues¶
Overview¶
This resource provides MPLS Queues statistics.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- mpls_queues : Operations related to mpls_queues
Paths¶
Get operation for mpls_queues¶
GET /mpls_queues
Description¶
Use this operation to get MPLS Queues statistics. Filter and Pagination are supported for this API. Refer Getting Started Guide where filtering and pagination is explained via example of application monitoring API
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | mpls_queues_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- mpls_queues
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
intranet_data_rates¶
MPLS Queues Intranet Data Rates Array
Type : < intranet_data_rates > array
| Name | Description | Schema |
|---|---|---|
| compression_bytes_saved_recv optional read-only |
IP, TCP, UDP Header compression bytes saved. Displayed only for Virtual Path Datarate | string |
| compression_bytes_saved_sent optional read-only |
IP, TCP, UDP Header compression bytes saved. Displayed only for Virtual Path Datarate | string |
| delta_kB_recv optional read-only |
Total delta bytes received in kB | string |
| delta_kB_sent optional read-only |
Total delta bytes sent in kB | string |
| delta_packets_recv optional read-only |
Total delta packets received | string |
| delta_packets_sent optional read-only |
Total delta packets sent | string |
| direction optional read-only |
Direction Of Datarate | string |
| mismatched_dscp_kB_recv optional read-only |
Mismatched DSCP bytes received in kB | string |
| mismatched_dscp_kB_sent optional read-only |
Mismatched DSCP bytes sent in kB | string |
| mismatched_dscp_packets_recv optional read-only |
Mismatched DSCP Packets received | string |
| mismatched_dscp_packets_sent optional read-only |
Mismatched DSCP Packets sent | string |
| mpls_queue_name optional read-only |
MPLS Queue Name | string |
| recv_rate_kbps optional read-only |
Received rate in kbps | string |
| routing_domain_name optional read-only |
Routing Domain Name | string |
| sent_rate_kbps optional read-only |
Sent rate in kbps | string |
| total_kB_recv optional read-only |
Total bytes received in kB | string |
| total_kB_sent optional read-only |
Total bytes sent in kB | string |
| total_packets_recv optional read-only |
Total Packets received | string |
| total_packets_sent optional read-only |
Total Packets sent | string |
mpls_queue_data¶
MPLS Queues stats array
Type : < mpls_queue_data > array
| Name | Description | Schema |
|---|---|---|
| ai_name optional read-only |
Access Interface Name | string |
| ip_address optional read-only |
MPLS IP Address | string |
| last_arp_reply_age optional read-only |
ARP Reply Age | string |
| mac optional read-only |
MPLS MAC Address | string |
| mpls_queue_name optional read-only |
MPLS Queue Name | string |
| private_mpls optional read-only |
Private MPLS Name | string |
| proxy_address optional read-only |
MPLS Proxy IP Address | string |
| proxy_arp_state optional read-only |
MPLS Proxy State | string |
| routing_domain_name optional read-only |
Routing Domain | string |
mpls_queues_delete_success_schema¶
| Name | Schema |
|---|---|
| mpls_queues optional |
mpls_queues |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
mpls_queues_post_success_schema¶
| Name | Schema |
|---|---|
| mpls_queues optional |
mpls_queues |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
mpls_queues_put_success_schema¶
| Name | Schema |
|---|---|
| mpls_queues optional |
mpls_queues |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
mpls_queues_response_schema¶
Type : < mpls_queues_response_schema > array
| Name | Schema |
|---|---|
| intranet_data_rates optional |
intranet_data_rates |
| mpls_queue_data optional |
mpls_queue_data |
| virtual_path_data_rates optional |
virtual_path_data_rates |
virtual_path_data_rates¶
MPLS Queues Virtual Paths Service Data Rates Array
Type : < virtual_path_data_rates > array
| Name | Description | Schema |
|---|---|---|
| compression_bytes_saved_recv optional read-only |
IP, TCP, UDP Header compression bytes saved. Displayed only for Virtual Path Datarate | string |
| compression_bytes_saved_sent optional read-only |
IP, TCP, UDP Header compression bytes saved. Displayed only for Virtual Path Datarate | string |
| delta_kB_recv optional read-only |
Total delta bytes received in kB | string |
| delta_kB_sent optional read-only |
Total delta bytes sent in kB | string |
| delta_packets_recv optional read-only |
Total delta packets received | string |
| delta_packets_sent optional read-only |
Total delta packets sent | string |
| direction optional read-only |
Direction Of Datarate | string |
| mismatched_dscp_kB_recv optional read-only |
Mismatched DSCP bytes received in kB | string |
| mismatched_dscp_kB_sent optional read-only |
Mismatched DSCP bytes sent in kB | string |
| mismatched_dscp_packets_recv optional read-only |
Mismatched DSCP Packets received | string |
| mismatched_dscp_packets_sent optional read-only |
Mismatched DSCP Packets sent | string |
| mpls_queue_name optional read-only |
MPLS Queue Name | string |
| recv_rate_kbps optional read-only |
Received rate in kbps | string |
| routing_domain_name optional read-only |
Routing Domain Name | string |
| sent_rate_kbps optional read-only |
Sent rate in kbps | string |
| total_kB_recv optional read-only |
Total bytes received in kB | string |
| total_kB_sent optional read-only |
Total bytes sent in kB | string |
| total_packets_recv optional read-only |
Total Packets received | string |
| total_packets_sent optional read-only |
Total Packets sent | string |