Skip to main content

Query DB for Policy Sets (v3.0)



Query the DB for policy sets that match the query parameters.


Path Parameters

    tenant_id stringrequired

    The tenant ID.


Query details for policy set

    aggregate Aggregate

    The aggregate number of policy sets that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string


    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]


    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    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.


Successful Operation

    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    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 double

    The high range of the bandwidth allocated.

    low double

    The low range of the bandwidth allocated.

    business_priorities BusinessPriority[]

    Information on the business priorities.

  • Array [
  • bandwidth_allocation double

    The bandwidth allocated.

    bandwidth_split_per_type BandwidthSplit

    The bandwidth split per type.

    bulk double


    rt_audio double

    Rt Audio

    rt_video double

    Rt Video

    transactional double


    priority_num int32

    The priority number.

  • ]
  • ]
  • business_priority_names BusinessPriorityNameMapper[]

    The list of business priority names. Max size = 4.

  • Array [
  • priority_name string

    The business priority name.

    priority_num int32

    The business priority number.

  • ]
  • default_policy boolean

    The default policy.


    The description of the policy set.

    id string

    The policy set ID.

    name string

    The name of the policy set. Max size = 128.

  • ]