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
- tenant_id string required
The tenant ID.
- application/json
Request Body
Query Details for the site
aggregate Aggregate
The aggregate number of sites 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 sites deleted for a time frame.
- group_by string[]
Group By
- id string
List the sites 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 SiteQueryFilterV4N5[]
Array [address Address
The address of the site.
city stringThe name of the city. Max size = 100.
country stringThe name of the country. Max size = 100.
post_code stringThe postal code. Max size = 100.
state stringThe name of the state. Max size = 100.
street stringThe name of the street. Max size = 100.
street2 stringThe name of the street. Max size = 100.
admin_state string requiredThe 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.
descriptionDescription for the site (Max size = 1024).
element_cluster_role string requiredThis 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)
Array [key stringKey
value stringValue
value_type stringValue Type
]id stringThe ID.
location Location
The geographical cordinates for the site address.
descriptionThe decsription of the location.
latitude floatThe latitude of the location. Max range = 90.
longitude floatThe longitude of the location. Max range = 180.
name string requiredThe site name (Max size = 128).
nat_policysetstack_id stringID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
network_policysetstack_id stringThe ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
policy_set_id stringThe ID for the Original Network Policy Set. Can be retrieved using policysets API.
priority_policysetstack_id stringID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
security_policyset_id stringThe ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.
service_binding stringBind a site to a set of domains. Can be retrieved using sericebindingmaps API.
tags string[]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"
]
}
]
}