NSX-T Data Center REST API

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

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", }, ... ] }

Required Permissions:

read

Feature:

system_alarms_events

Additional Errors: