Query Priority Policy Rules (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/prioritypolicyrules/query

Query the priority policy rules.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query details for Priority Policy rules

aggregate Aggregate

The aggregate number of priority policy rules 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

Field

name string

The name of the query response.

operator string

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

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of priority policy rules deleted for a time frame.

group_by string[]

Group the priority policy rules for the query.

id string

Lists the priority policy rules 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.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

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 PriorityPolicyRuleQueryFilterV2N1[]
Array [
app_def_ids string[]
The app definition IDs that have applied priority policy rules. The number of applications for a policy rule is limited to 256.
description
The description of the priority policy rule. Max size = 256.
destination_prefixes_id string
The destination prefix ID.
dscp DSCP
The DSCP value - When policy rules with marked DSCP bits are applied to a site, the ION branch device will honor the bits in the first packet on an unknown application flow, and queue the flow in the specified priority class.
value int32
The DSCP value.
enabled boolean
The priority policy rules based on rules that are enabled.
id string
The priority policy rule ID.
name stringrequired
The name of the priority policy rule. Max size = 128.
network_context_id string
The network context applied to the priority policy rule. Network context segments network traffic for the purpose of applying different QoS policy rules for the same application.
order_number integer
The order number. The default order number for a policy rule is 1024.
policyset_id string
The policy set ID.
priority_number int32required
The priority number. Priority determines the relative priority of network resources assigned to each application.
source_prefixes_id string
The source prefix ID. Source prefix filters are often added as exceptions.
tags string[]
A information field that can be added to identify the priority policy rule. Maximum 10 unique tags of length 1024 each are allowed.
user_or_group UserGroup
The details of the user or group.
user_group_ids string[]
The user group IDs.
user_ids string[]
The user IDs.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "app_def_ids": [
        "string"
      ],
      "destination_prefixes_id": "string",
      "dscp": {
        "value": 0
      },
      "enabled": true,
      "id": "string",
      "name": "string",
      "network_context_id": "string",
      "order_number": 0,
      "policyset_id": "string",
      "priority_number": 0,
      "source_prefixes_id": "string",
      "tags": [
        "string"
      ],
      "user_or_group": {
        "user_group_ids": [
          "string"
        ],
        "user_ids": [
          "string"
        ]
      }
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...