Get Alarm Counts By Category And Severity

When invoking this API, the Alarm instances are accounted for in a map where the key is a category, by default feature name, and the value contains counts by severity. When the optional FeatureName request parameter is specified, the resulting list will only include the feature names passed along with the instance counts by severity for those features.

Request

URI

POST

https://{api_host}/ssp/alarms/counts

COPY

Request Body

AlarmInstanceCountFilterRequest of type(s) application/json

Optional

Show optional properties

{
    "group_by": "string"
}

{
    "filter_match": [
        "string"
    ],
    "group_by": "string",
    "before": 0,
    "after": 0
}

array of string

filter_match

Optional

Filter alarm instances by group_by type

string

group_by

Required

Alarm count group by type

Possible values are : FEATURE_NAME, EVENT_TYPE,

integer As int64 As int64

before

Optional

Timestamp in milliseconds since epoch

integer As int64 As int64

after

Optional

Timestamp in milliseconds since epoch

Authentication

This operation uses the following authentication methods.

Responses

200

Alarm Instance Count Response OK

Returns AlarmCounts of type(s) application/json

"AlarmCounts Object"

array of object

open_instance_counts

Optional

List of open alarm counts grouped by both categories and severity.

array of object

suppressed_instance_counts

Optional

List of suppressed alarm counts grouped by both categories and severity.

array of object

resolved_instance_counts

Optional

List of resolved alarm counts grouped by both categories and severity.

array of object

acknowledged_instance_counts

Optional

List of acknowledged alarm counts grouped by both categories and severity.

integer As int64 As int64

total_instance_count

Optional

Total count of Alarm instances found (across all pages)

400

Bad Request for Alarm Instance counts

Returns Error of type(s) application/json

"Error Object"

integer

error_code

Required

HTTP Status or Application error code

string

module_name

Optional

Module where the error happened

string

error_message

Required

Message describing the error

404

Alarm Instance Counts Not Found

Returns Error of type(s) application/json

"Error Object"

integer

error_code

Required

HTTP Status or Application error code

string

module_name

Optional

Module where the error happened

string

error_message

Required

Message describing the error

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"group_by:"string"}' https://{api_host}/ssp/alarms/counts

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Alarms Operations

POST

Filter Alarm Definitions

GET