Skip to main content

Query Performance Policy Rules (v2.1)

POST 

/sdwan/v2.1/api/perfmgmtpolicyrules/query

Query the performance management policy rules.

Request

Body

Details of the query for PERFMGMT Policy Rule

    aggregate Aggregate

    The aggregate number of performance 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

    The field value.

    name string

    The name of the query response.

    operator string

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

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number performance policy rules deleted for a time frame.

    group_by string[]

    Group the performance policy rules for the query.

    id string

    List the performance 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

    Query using query parameters.

    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object

    Specify the order in which you want the search criteria to display.

    total_count int64

    The total number of query parameters.

Responses

Successful Operation

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.

    total_count int64

    Total number.

    items PerfMgmtPolicyRuleQueryFilterV2N1[]
  • Array [
  • actions PerfMgmtActionV2N1[]

    The valid actions configured for the performance policy rule.

  • Array [
  • action_type stringrequired

    Possible values: [RAISE_ALARM, MOVE_FLOWS, MOVE_FLOWS_FORCED, FEC, VISIBILITY, APP_ACCELERATION, PACKET_DUPLICATION]

    The values of the action type for the performance policy rule.

    app_perf PerfMgmtActionParameters

    The details of the application performance parameters.

    bad_health_thresholds PerfMgmtHealthThresholds

    Lists the valid / invalid performance policy rules thresholds.

    clear_below int32

    The clear_below value should be between 1-80L.

    raise_above int32

    The raise_above value should be between 10-100L.

    monitoring_approach stringrequired

    Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]

    The monitoring approach for the rule.

    circuit_utilization_perf PerfMgmtActionParameters

    The details of the circuit utilization parameters.

    bad_health_thresholds PerfMgmtHealthThresholds

    Lists the valid / invalid performance policy rules thresholds.

    clear_below int32

    The clear_below value should be between 1-80L.

    raise_above int32

    The raise_above value should be between 10-100L.

    monitoring_approach stringrequired

    Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]

    The monitoring approach for the rule.

    lqm_perf PerfMgmtActionParameters

    The details of the LQM performance parameters.

    bad_health_thresholds PerfMgmtHealthThresholds

    Lists the valid / invalid performance policy rules thresholds.

    clear_below int32

    The clear_below value should be between 1-80L.

    raise_above int32

    The raise_above value should be between 10-100L.

    monitoring_approach stringrequired

    Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]

    The monitoring approach for the rule.

    probe_perf PerfMgmtActionParameters

    The details of the probe performance parameters.

    bad_health_thresholds PerfMgmtHealthThresholds

    Lists the valid / invalid performance policy rules thresholds.

    clear_below int32

    The clear_below value should be between 1-80L.

    raise_above int32

    The raise_above value should be between 10-100L.

    monitoring_approach stringrequired

    Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]

    The monitoring approach for the rule.

    sys_perf PerfMgmtActionParameters

    The details of the system performance parameters.

    bad_health_thresholds PerfMgmtHealthThresholds

    Lists the valid / invalid performance policy rules thresholds.

    clear_below int32

    The clear_below value should be between 1-80L.

    raise_above int32

    The raise_above value should be between 10-100L.

    monitoring_approach stringrequired

    Possible values: [AGGRESSIVE, MODERATE, CONSERVATIVE]

    The monitoring approach for the rule.

  • ]
  • app_filters ApplicationFilter

    The details of the app filters used for the performance policy rule.

    app_transfer_types string[]

    Possible values: [RT_AUDIO, RT_VIDEO, TRANSACTIONAL, BULK]

    Lists the app transfer types. Maximum 4 app transfer types are supported.

    application_ids string[]

    Lists the application IDs in a rule. Maximum 64 applications can be specified in a rule.

    description

    The description of the performance policy rule. Max characters = 256.

    enabled boolean

    Lists if the performance policy rule is enabled.

    id string

    Lists the performance policy rules by ID.

    name stringrequired

    The name of the performance policy rule.

    path_filters PathFilter[]

    Lists the path filters applied. Maximum 32 path filters are supported.

  • Array [
  • label string

    The policy rule path label.

    path_type stringrequired

    Possible values: [vpn, direct, servicelink, all]

    The path type specified in the path filter.

  • ]
  • service_label_ids string[]

    Lists the service label IDs. Maximum 32 service labels are supported.

    tags string[]

    A information field that can be added to identify the performance policy rule. Maximum 10 unique tags of length 1024 each are allowed.

    thresholdprofile_id string

    Lists the threshold profile IDs.

    type stringrequired

    Possible values: [APP_CIRCUIT_HEALTH, SYSTEM_SITE_HEALTH]

    The type of performance policy rule.

  • ]
Loading...