Skip to main content

Queries DB for Number of Event Correlation Policy Sets (v2.0)

POST 

/sdwan/v2.0/api/eventcorrelationpolicysets

Queries the DB for limit number of event correlation policy sets that match query parameters.

Request

Body

Query Details for Event Correlation Policy

    aggregate Aggregate

    The aggregate number of queried rules.

    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 of queried rules deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the event state 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

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 EventCorrelationPolicySetQueryFilter[]
  • Array [
  • active_policyset boolean

    Event policy sets set to active.

    clone_from string

    Policy sets cloned from existing policy sets.

    description

    Description of the event policy set.

    id string

    ID of the event policy set.

    name stringrequired

    Name of the event policy set. Max 25 characters.

    policyrule_order string[]

    The order for the execution of the policy rule.

    severity_priority_mapping SeverityPriorityMapping[]

    Mapping of the priority and severity levels.

  • Array [
  • priority stringrequired

    Possible values: [p1, p2, p3, p4, p5, none]

    Priority specified for the rule. Range from Priority 1 (P1), through Priority 5 (P5).

    severity stringrequired

    Possible values: [major, minor, critical]

    Severity of the rule.

  • ]
  • tags string[]

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

  • ]
Loading...