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

POST 
/v2.0/api/tenants/:tenant_id/eventcorrelationpolicysets/query

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

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

application/json

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

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 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

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 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.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "active_policyset": true,
      "clone_from": "string",
      "id": "string",
      "name": "string",
      "policyrule_order": [
        "string"
      ],
      "severity_priority_mapping": [
        {
          "priority": "p1",
          "severity": "major"
        }
      ],
      "tags": [
        "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...