Get the list of all Alarms currently known to the system.

Returns a list of all Alarms currently known to the system.

Request:

Method:

GET

URI Path(s):

/api/v1/alarms

Request Headers:

n/a

Query Parameters:

AlarmFilterParameter+

AlarmFilterParameter (schema)

Name	Description	Type	Notes
after	Filter to fetch alarms after the specified time Filter to fetch alarms after the specified time.	EpochMsTimestamp
before	Filter to fetch alarms before the specified time Filter to fetch alarms before the specified time.	EpochMsTimestamp
cursor	Cursor for pagination Opaque cursor to be used for getting next page of records (supplied by current result page).	string
event_type	Event Type Filter Specify one or more event types for which alarms should be filtered.	string
feature_name	Feature Name Specify one or more feature names for which alarms should be filtered.	string
id	Alarm ID Specify one or more alarm IDs for which alarms should be filtered.	string
intent_path	Intent Path for entity ID Specify one or more intent paths for which alarms should be filtered.	string
node_id	Node ID Specify one or more node IDs for which alarms should be filtered.	string
node_resource_type	Node Resource Type Specify one or more node resource types for which alarms should be filtered.	string
page_size	Page Size for pagination Maximum number of results to return in this page (server may return fewer).	integer
severity	Severity Specify one or more severity levels for which alarms should be filtered. Must be one of CRITICAL, HIGH, MEDIUM, LOW.	string
sort_ascending	Represents order of sorting the values If true, the value of the column are sorted in ascending order. Otherwise, in descending order.	boolean	Default: "True"
sort_by	Key for sorting on this column Sorting on column is based on the sort_by. sort_by represents the field in the output data on which sort is requested.	string
status	Status Specify one or more status for which alarms should be filtered. Must be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.	string

Request Body:

n/a

Example Request:

GET /api/v1/alarms?status=OPEN

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AlarmsListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of alarms known to the system	array of Alarm	Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 4, "results": [ { "id": "daabc688-3a90-4545-9af8-23e1b045e6f3", "status": "OPEN", "feature_name": "manager_health", "event_type": "manager_cpu_usage_high", "feature_display_name": "Manager Health", "event_type_display_name": "CPU Usage High", "node_id": "8af5d6d7-e8bc-454d-90bd-4824782216ea", "last_reported_time": 1551994806, "description": | "The CPU usage for the manager node identified by appears to be\nrising.", "recommended_action": | "Use the top command to check which processes have the most CPU usages, and\nthen check \/var\/log\/syslog and these processes' local logs to see if there\nare any outstanding errors to be resolved.", "node_resource_type": "ClusterNodeConfig", "severity": "WARNING", "entity_resource_type": "ClusterNodeConfig", }, ... ] }

Get the list of all Alarms currently known to the system.

Request:

AlarmFilterParameter (schema)

Example Request:

Successful Response:

AlarmsListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: