Query DB for Site WAN Interfaces (v2.8)
POST/sdwan/v2.8/api/waninterfaces/query
Query the DB for site WAN interfaces that match query parameters.
Request
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of app defs that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
The destination page.
The number app definitions deleted for a time frame.
Group By
List the app definitions by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items WANInterfaceQueryFilterV2N8[]
Possible values: [aggressive
, non_aggressive
]
Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, nullAllowed = false)
Possible values: [auto
, manual
, manual_bwm_disabled
]
Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false)
Bwc Enabled
Cost: Range(max = 1024L, error = WANINTERFACE_INVALID_COST_VALUE: Cost value for site WAN interface should be within range 0-1024, min = 0L)
Description: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, min = 0)
Id
l3_reachability WANL3Reachability
L3 Reachability: Valid
The probe configuration IDs.
The default element used.
Label Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL)
Link Bw Down: JsonIgnore(value = true)
Link Bw Up: JsonIgnore(value = true)
lqm_config LQMConfig
Lqm Config: Valid
List of DC Site IDs.
Allowed values: 50-300 milliseconds.
Possible values: [min
, max
, avg
]
WAN interface LQM config statistics.
Lqm Enabled
Name: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, min = 0)
Network Id: NotEmpty(message = NETWORK_ID_REQD)
Probe Profile Id
Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull
Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\s]+, required = false)
Possible values: [PUBLIC_WAN
, PRIVATE_WAN
]
Type
Use For Application Reachability Probes: Valid
Use For Controller Connections: Valid
Use Lqm For Non Hub Paths
vpnlink_configuration VPNLinkConfiguration
Vpnlink Configuration: Valid Valid Nullable
The VPN keep alive failure count (must be between 3 and 30).
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"bfd_mode": "aggressive",
"bw_config_mode": "auto",
"bwc_enabled": true,
"cost": 0,
"description": "string",
"id": "string",
"l3_reachability": {
"probe_config_ids": [
"string"
],
"use_element_default": true
},
"label_id": "string",
"link_bw_down": 0,
"link_bw_up": 0,
"lqm_config": {
"hub_site_ids": [
"string"
],
"inter_packet_gap": 0,
"statistic": "min"
},
"lqm_enabled": true,
"name": "string",
"network_id": "string",
"probe_profile_id": "string",
"site_id": "string",
"tags": [
"string"
],
"type": "PUBLIC_WAN",
"use_for_application_reachability_probes": true,
"use_for_controller_connections": true,
"use_lqm_for_non_hub_paths": true,
"vpnlink_configuration": {
"keep_alive_failure_count": 0,
"keep_alive_interval": 0
}
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}