Query DB for Site WAN Interfaces (v2.5)
Queries the DB for Site WAN Interfaces that match the query parameters.
Path Parameters
- tenant_id string required
The tenant ID.
- site_id string required
ID of the site. More details on the site can be retrieved by querying the sites API.
- 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
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 WANInterfaceQuery[]
Array [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 int32The destination page.
getDeleted booleanThe number WAN interfaces deleted for a time frame.
group_by string[]Group By
id stringList the WAN interfaces by ID.
last_query_ts int64Return the ID of a specified query in the current session.
limit int32The query limit.
next_query objectThe limit.
query_params objectretrieved_fields string[]Retrieve information from a field.
retrieved_fields_mask booleanList the fields to query.
sort_params objecttotal_count int64The total number of query parameters.
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"aggregate": {
"field": "string",
"operator": "max"
},
"dest_page": 0,
"getDeleted": true,
"group_by": [
"string"
],
"id": "string",
"last_query_ts": 0,
"limit": 0,
"next_query": {},
"query_params": {},
"retrieved_fields": [
"string"
],
"retrieved_fields_mask": true,
"sort_params": {},
"total_count": 0
}
]
}