Query Event Summary (v2.0)

POST 
/sdwan/v2.0/api/events/summary

Provides summary of events for a given tenant.

Request

application/json

Body

element_cluster_role string

Possible values: [HUB, SPOKE, NONE]

The element cluster role.

end_time string

The event end time.

group_by string[]

Possible values: [priority, code, tenant]

The event grouping.

query object

The query details of event code and type.

code string[]

type string[]

Possible values: [alarm, alert]

start_time string

The event start time.

Responses

200

Successful Operation

application/json

Schema

Schema

oneOf

EventsSummaryData

_status_code integer

The status code of the event.

count integer

The event count.

data object[]

The details of the event code, priority, and tenant IDs.

Array [

code string

priority string

tenant_ids string

]

type string

Possible values: [alarm, alert]

The event type.

EventsSummaryTenantData

_status_code integer

The status code of the event.

count integer

The event count.

data object[]

The details of the event code, priority, and tenant IDs.

Array [

alarms object

p1 integer

p2 integer

p3 integer

p4 integer

p5 integer

alerts object

p1 integer

p2 integer

p3 integer

p4 integer

p5 integer

tenant_id string

]

type string

Possible values: [alarm, alert]

The event type.

Example (from schema)

{}

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": "INVALID_REQUEST_ERROR_0001"
      }
    ]
  }
}

Loading...