access_interfaces¶
Overview¶
This resource provides Access Interface Stat.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP
Tags¶
- access_interfaces : Operations related to access_interfaces
Paths¶
Get operation for access_interfaces¶
GET /access_interfaces
Description¶
Use this operation to get Access Interface 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 | access_interfaces_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¶
- access_interfaces
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
access_interface¶
Access Interface Stats Array
Type : < access_interface > 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 |
| wanlink_name optional read-only |
WAN Link Name | string |
access_interfaces_delete_success_schema¶
| Name | Schema |
|---|---|
| access_interfaces optional |
access_interfaces |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
access_interfaces_post_success_schema¶
| Name | Schema |
|---|---|
| access_interfaces optional |
access_interfaces |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
access_interfaces_put_success_schema¶
| Name | Schema |
|---|---|
| access_interfaces optional |
access_interfaces |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
access_interfaces_response_schema¶
Type : < access_interfaces_response_schema > array
access_interfaces_response_schema
| Name | Schema |
|---|---|
| access_interface optional |
access_interface |
| internet_data_rates optional |
internet_data_rates |
| intranet_data_rates optional |
intranet_data_rates |
| virtual_path_data_rates optional |
virtual_path_data_rates |
internet_data_rates¶
Access Interface Internet Data Rates Array
Type : < internet_data_rates > array
| Name | Description | Schema |
|---|---|---|
| ai_name optional read-only |
Access Interface Name | string |
| bytes_saved optional read-only |
Bytes Saved. Displayed only for Virtual Path Datarate | 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 |
| rcvd_rate_kbps optional read-only |
Received rate kbps | number |
| routing_domain_name optional read-only |
Routing Domain Name. Displayed only for Intranet Datarate | string |
| sent_rate_kbps optional read-only |
Sent rate kbps | number |
| service_name optional read-only |
Service Name | string |
| 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 |
| wanlink_name optional read-only |
WAN Link Name | string |
intranet_data_rates¶
Access Interface Intranet Data Rates Array
Type : < intranet_data_rates > array
| Name | Description | Schema |
|---|---|---|
| ai_name optional read-only |
Access Interface Name | string |
| bytes_saved optional read-only |
Bytes Saved. Displayed only for Virtual Path Datarate | 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 |
| rcvd_rate_kbps optional read-only |
Received rate kbps | number |
| routing_domain_name optional read-only |
Routing Domain Name. Displayed only for Intranet Datarate | string |
| sent_rate_kbps optional read-only |
Sent rate kbps | number |
| service_name optional read-only |
Service Name | string |
| 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 |
| wanlink_name optional read-only |
WAN Link Name | string |
virtual_path_data_rates¶
Access Interface Virtual Paths Service Data Rates Array
Type : < virtual_path_data_rates > array
| Name | Description | Schema |
|---|---|---|
| ai_name optional read-only |
Access Interface Name | string |
| bytes_saved optional read-only |
Bytes Saved. Displayed only for Virtual Path Datarate | 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 |
| rcvd_rate_kbps optional read-only |
Received rate kbps | number |
| routing_domain_name optional read-only |
Routing Domain Name. Displayed only for Intranet Datarate | string |
| sent_rate_kbps optional read-only |
Sent rate kbps | number |
| service_name optional read-only |
Service Name | string |
| 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 |
| wanlink_name optional read-only |
WAN Link Name | string |