wanlinkstat¶
Overview¶
This resource provides WAN Link Stat.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- wanlinkstat : Operations related to wanlinkstat
Paths¶
Get operation for wanlinkstat¶
GET /wanlinkstat
Description¶
Use this operation to get WAN Link 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 | wanlinkstat_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¶
- wanlinkstat
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
internet_data_rates¶
Wan Link Internet Data Rates Array
Type : < internet_data_rates > array
| Name | Description | Schema |
|---|---|---|
| bytes_saved optional read-only |
Bytes Saved | string |
| delta_bytes_rcvd optional read-only |
Delta Bytes Received | string |
| delta_bytes_sent optional read-only |
Delta Bytes Sent | string |
| delta_packets_rcvd optional read-only |
Delta Packets Received | string |
| delta_packets_sent optional read-only |
Delta Packets Sent | string |
| direction optional read-only |
Direction Of Datarate | string |
| name optional read-only |
WAN Link Name | string |
| routing_domain_name optional read-only |
WAN Link Routing Domain Name | string |
| time_diff optional read-only |
Time Difference | integer |
| total_bytes_rcvd optional read-only |
Total Bytes Recieved | string |
| total_bytes_sent optional read-only |
Total Bytes Sent | string |
| total_packets_rcvd optional read-only |
Total Packets received | string |
| total_packets_sent optional read-only |
Total Packets Sent | string |
intranet_data_rates¶
Wan Link Internet Data Rates Array
Type : < intranet_data_rates > array
| Name | Description | Schema |
|---|---|---|
| bytes_saved optional read-only |
Bytes Saved | string |
| delta_bytes_rcvd optional read-only |
Delta Bytes Received | string |
| delta_bytes_sent optional read-only |
Delta Bytes Sent | string |
| delta_packets_rcvd optional read-only |
Delta Packets Received | string |
| delta_packets_sent optional read-only |
Delta Packets Sent | string |
| direction optional read-only |
Direction Of Datarate | string |
| name optional read-only |
WAN Link Name | string |
| routing_domain_name optional read-only |
WAN Link Routing Domain Name | string |
| time_diff optional read-only |
Time Difference | integer |
| total_bytes_rcvd optional read-only |
Total Bytes Recieved | string |
| total_bytes_sent optional read-only |
Total Bytes Sent | string |
| total_packets_rcvd optional read-only |
Total Packets received | string |
| total_packets_sent optional read-only |
Total Packets Sent | string |
virtual_path_data_rates¶
Wan Link Virtual Paths Data Rate Array
Type : < virtual_path_data_rates > array
| Name | Description | Schema |
|---|---|---|
| bytes_saved optional read-only |
Bytes Saved | string |
| delta_bytes_rcvd optional read-only |
Delta Bytes Received | string |
| delta_bytes_sent optional read-only |
Delta Bytes Sent | string |
| delta_packets_rcvd optional read-only |
Delta Packets Received | string |
| delta_packets_sent optional read-only |
Delta Packets Sent | string |
| direction optional read-only |
Direction Of Datarate | string |
| name optional read-only |
WAN Link Name | string |
| routing_domain_name optional read-only |
WAN Link Routing Domain Name | string |
| time_diff optional read-only |
Time Difference | integer |
| total_bytes_rcvd optional read-only |
Total Bytes Recieved | string |
| total_bytes_sent optional read-only |
Total Bytes Sent | string |
| total_packets_rcvd optional read-only |
Total Packets received | string |
| total_packets_sent optional read-only |
Total Packets Sent | string |
wan_link¶
Wan Link Stats Array
Type : < wan_link > array
| Name | Description | Schema |
|---|---|---|
| ai_name optional read-only |
WAN Link Access Interface Name | string |
| ip_address optional read-only |
WAN Link IP Address | string |
| last_arp_reply_age optional read-only |
ARP Reply Age | string |
| mac optional read-only |
WAN Link MAC Address | string |
| proxy_arp_state optional read-only |
WAN Link PROXY State | string |
| proxy_ip_address optional read-only |
WAN Link PROXY IP Address | string |
| routing_domain_name optional read-only |
WAN Link Routing Domain | string |
| wl_name optional read-only |
WAN Link Name | string |
wanlinkstat_delete_success_schema¶
| Name | Schema |
|---|---|
| wanlinkstat optional |
wanlinkstat |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
wanlinkstat_post_success_schema¶
| Name | Schema |
|---|---|
| wanlinkstat optional |
wanlinkstat |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
wanlinkstat_put_success_schema¶
| Name | Schema |
|---|---|
| wanlinkstat optional |
wanlinkstat |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
wanlinkstat_response_schema¶
Type : < wanlinkstat_response_schema > array
| Name | Schema |
|---|---|
| internet_data_rates optional |
internet_data_rates |
| intranet_data_rates optional |
intranet_data_rates |
| virtual_path_data_rates optional |
virtual_path_data_rates |
| wan_link optional |
wan_link |