Query DB for Number of Sites that Match Query Params (v4.5)
Queries the DB for limit number of sites that match the query parameters.
Path Parameters
The tenant ID.
Request Body
Query Details for the site
- Array [
- ]
aggregate Aggregate
The aggregate number of sites that match the query parameters.
data AggregateData[] required
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
Field
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
Operator
QoS application aggregate statistics.
The unit.
The destination page.
The number sites deleted for a time frame.
Group By
List the sites 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.
- 200
Successful Operation
Schema
- Array [
- Array [
- ]
- ]
The count of the query list.
The deleted number of queries.
The deleted query IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
The tenant ID.
Total number of queries.
items SiteQueryFilterV4N5[]
address Address
The address of the site.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.
Description for the site (Max size = 1024).
This attribute describes the type i.e. SPOKE or HUB.
extended_tags ExtendedTag[]
Extended Tags: Valid ListObject(allowDuplicate = false, allowEmpty = true, allowNull = true, listMaxSize = 10, message = INVALID_EXTENDED_TAG_SIZE_OR_DUPLICATE, required = false)
Key
Value
Value Type
The ID.
location Location
The geographical cordinates for the site address.
The decsription of the location.
The latitude of the location. Max range = 90.
The longitude of the location. Max range = 180.
The site name (Max size = 128).
ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
The ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
The ID for the Original Network Policy Set. Can be retrieved using policysets API.
ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.
A information field that can be added to identify the site.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"address": {
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"admin_state": "string",
"element_cluster_role": "string",
"extended_tags": [
{
"key": "string",
"value": "string",
"value_type": "string"
}
],
"id": "string",
"location": {
"latitude": 0,
"longitude": 0
},
"name": "string",
"nat_policysetstack_id": "string",
"network_policysetstack_id": "string",
"policy_set_id": "string",
"priority_policysetstack_id": "string",
"security_policyset_id": "string",
"service_binding": "string",
"tags": [
"string"
]
}
]
}