Query DB for Site WAN Interfaces (v2.7)
Queries the DB for Site WAN Interfaces that match the query parameters.
Path Parameters
- tenant_id string required
The tenant ID.
- application/json
Request Body
aggregate Aggregate
The aggregate number of WAN interfaces that match the query parameters.
field stringThe field value.
operator stringPossible values: [
max
,count
,min
,avg
,sum
]The operator values.
- dest_page int32
The destination page.
- getDeleted boolean
The number WAN interfaces deleted for a time frame.
- group_by string[]
Group By
- id string
List the WAN interfaces by ID.
- last_query_ts int64
Return the ID of a specified query in the current session.
- limit int32
The query limit.
- next_query object
The limit.
- query_params object
- retrieved_fields string[]
Retrieve information from a field.
- retrieved_fields_mask boolean
List the fields to query.
- sort_params object
- total_count int64
The total number of query parameters.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- count int32
The count of the query list.
- deleted_count int64
The deleted number of queries.
- deleted_ids string[]
The deleted query IDs.
- description
Description of the query. Max size = 256.
- id string
The ID.
- next_query object
Details of the next query.
- tenant_id string
- total_count int64
Total number of queries.
items WANInterfaceQueryFilterV2N7[]
Array [bfd_mode string requiredPossible values: [
aggressive
,non_aggressive
]Bfd Mode: ValidateEnum(enumClass = classOf[BfdMode], WAN_CONFIG_INVALID_BFD_MODE, nullAllowed = false)
bw_config_mode string requiredPossible values: [
auto
,manual
,manual_bwm_disabled
]Bw Config Mode: ValidateEnum(enumClass = classOf[BWConfigMode], message = INVALID_BANDWIDTH_CONFIG_MODE, nullAllowed = false)
bwc_enabled booleanBwc Enabled
cost integerCost: Range(max = 1024L, error = WANINTERFACE_INVALID_COST_VALUE: Cost value for site WAN interface should be within range 0-1024, min = 0L)
description stringDescription: Size(max = 256, WANINTERFACE_CONFIG_DESCRIPTION_EXCEEDS_LIMIT, min = 0)
id stringId
label_id string requiredLabel Id: NotEmpty(message = WAN_INTERFACE_INVALID_LABEL)
link_bw_down doubleLink Bw Down: JsonIgnore(value = true)
link_bw_up doubleLink Bw Up: JsonIgnore(value = true)
lqm_config LQMConfig
Lqm Config: Valid
hub_site_ids string[]List of DC Site IDs.
inter_packet_gap int32Allowed values: 50-300 milliseconds.
statistic stringPossible values: [
min
,max
,avg
]WAN interface LQM config statistics.
lqm_enabled booleanLqm Enabled
name stringName: Size(max = 128, WANINTERFACE_CONFIG_NAME_EXCEEDS_LIMIT, min = 0)
network_id string requiredNetwork Id: NotEmpty(message = NETWORK_ID_REQD)
site_id string requiredSite Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull
tags string[]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)
type stringPossible values: [
PUBLIC_WAN
,PRIVATE_WAN
]Type
use_for_application_reachability_probes booleanUse For Application Reachability Probes: Valid
use_for_controller_connections booleanUse For Controller Connections: Valid
use_lqm_for_non_hub_paths booleanUse Lqm For Non Hub Paths
vpnlink_configuration VPNLinkConfiguration
Vpnlink Configuration: Valid Nullable
keep_alive_failure_count integer requiredThe VPN keep alive failure count (must be between 3 and 30).
keep_alive_interval integer requiredThe VPN keep alive timeout interval (must be between 100ms-1740,000ms).
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"bfd_mode": "aggressive",
"bw_config_mode": "auto",
"bwc_enabled": true,
"cost": 0,
"description": "string",
"id": "string",
"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",
"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
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}