Query DB for Policy Sets (v3.0)
Query the DB for policy sets that match the query parameters.
Path Parameters
- tenant_id string required
The tenant ID.
- application/json
Request Body
Query details for policy set
aggregate Aggregate
The aggregate number of policy sets 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 of policy sets deleted for a time frame.
- group_by string[]
Group the policy sets for the query.
- id string
Lists the policy sets 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 PolicySetQueryFilter[]
Array [bandwidth_allocation_schemes BandwidthAllocationScheme[]
Allocate or modify the percentage of bandwidth configured for each priority and application traffic type. Can configure up to four bandwidth allocation schemes.
Array [bandwidth_range BandwidthRange
The details of the bandwidth range.
high doubleThe high range of the bandwidth allocated.
low doubleThe low range of the bandwidth allocated.
business_priorities BusinessPriority[]
Information on the business priorities.
Array [bandwidth_allocation doubleThe bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth split per type.
bulk doubleBulk
rt_audio doubleRt Audio
rt_video doubleRt Video
transactional doubleTransactional
priority_num int32The priority number.
]]business_priority_names BusinessPriorityNameMapper[]
The list of business priority names. Max size = 4.
Array [priority_name stringThe business priority name.
priority_num int32The business priority number.
]default_policy booleanThe default policy.
descriptionThe description of the policy set.
id stringThe policy set ID.
name stringThe name of the policy set. Max size = 128.
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"bandwidth_allocation_schemes": [
{
"bandwidth_range": {
"high": 0,
"low": 0
},
"business_priorities": [
{
"bandwidth_allocation": 0,
"bandwidth_split_per_type": {
"bulk": 0,
"rt_audio": 0,
"rt_video": 0,
"transactional": 0
},
"priority_num": 0
}
]
}
],
"business_priority_names": [
{
"priority_name": "string",
"priority_num": 0
}
],
"default_policy": true,
"id": "string",
"name": "string"
}
]
}
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"
}
]
}
}