Skip to content

wan_link_usage_stats

Overview

This resource provides WAN Links Usage Statistics

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/monitor/
Schemes : HTTP

Tags

  • wan_link_usage_stats : Operations related to wan_link_usage_stats

Paths

Get operation for wan_link_usage_stats

GET /wan_link_usage_stats

Description

Use this operation to get WAN Links Usage 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 wan_link_usage_stats_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

  • wan_link_usage_stats

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

Local WAN Links Statistics

Type : < local_wan_links > array

local_wan_links

Name Description Schema
congestion
optional
read-only
Congestion in the WAN Link enum (YES, NO, N/A)
delta_kb
optional
read-only
Delta KB in Local WAN Link number
delta_packets
optional
read-only
Delta packets transferred number
direction
optional
read-only
Direction enum (Send, Recv)
kbps
optional
read-only
kilobytes per second number
packets
optional
read-only
Total packets transferred integer
permitted_kbps
optional
read-only
kilobytes per second number
wan_link_name
optional
read-only
WAN Link name string

on_demand_wan_link_usage

On-demand WAN Links Statistics

Type : < on_demand_wan_link_usage > array

on_demand_wan_link_usage

Name Description Schema
configured
optional
read-only
Whether the WAN Links is configured string
current_allowed_bw_kbps
optional
read-only
Current allowed bandwidth in kbps number
in_use
optional
read-only
Whether the WAN Link is in use number
maximum_allowed_bw_kbps
optional
read-only
Maximum allowed banddwidth in kbps number
minimum_acceptable_bw_kbps
optional
read-only
Minimum acceptable bandwidth in kbps number
standby_priority
optional
read-only
Standby Priority string
virtual_path_available_bandwidth_kbps
optional
read-only
Virtual Path Available Bandwidth in kbps number
virtual_path_name
optional
read-only
The name of the Virtual Path string
virtual_path_on_demand_bandwidth_limit_kbps
optional
read-only
Virtual Path On Demand Bandwidth Limit in kbps number
wan_link_name
optional
read-only
WAN Link name string

Remote WAN Links Statistics

Type : < remote_wan_links > array

remote_wan_links

Name Description Schema
congestion
optional
read-only
Congestion in the WAN Link enum (YES, NO, N/A)
direction
optional
read-only
Direction enum (Send, Recv)
service
optional
read-only
The Service name string
wan_link_name
optional
read-only
WAN Link name string

usage_and_permitted_rate

Usage and Permitted Rates Statistics

Type : < usage_and_permitted_rate > array

usage_and_permitted_rate

Name Description Schema
congestion
optional
read-only
Congestion in the WAN Link enum (YES, NO, N/A)
delta_packets
optional
read-only
Delta packets transferred integer
delta_packets_kb
optional
read-only
Delta Packets KB in Local WAN Link number
direction
optional
read-only
Direction enum (Send, Recv)
kbps
optional
read-only
kilobytes per second number
packets
optional
read-only
Total packets transferred integer
packets_kb
optional
read-only
Total packets kb transferred number
permitted_kbps
optional
read-only
kilobytes per second number
service
optional
read-only
Service name string
wan_link_name
optional
read-only
WAN Link name string

wan_link_usage_stats_delete_success_schema

Name Schema
wan_link_usage_stats
optional
wan_link_usage_stats

wan_link_usage_stats

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

wan_link_usage_stats_post_success_schema

Name Schema
wan_link_usage_stats
optional
wan_link_usage_stats

wan_link_usage_stats

Name Description Schema
message
optional
Example : "resource added succesfully" string

wan_link_usage_stats_put_success_schema

Name Schema
wan_link_usage_stats
optional
wan_link_usage_stats

wan_link_usage_stats

Name Description Schema
message
optional
Example : "resource modified succesfully" string

wan_link_usage_stats_response_schema

Type : < wan_link_usage_stats_response_schema > array

wan_link_usage_stats_response_schema

Name Schema
local_wan_links
optional
local_wan_links
on_demand_wan_link_usage
optional
on_demand_wan_link_usage
remote_wan_links
optional
remote_wan_links
usage_and_permitted_rate
optional
usage_and_permitted_rate