api.mon.alerting
¶
/mon/alert¶
-
api.mon.alerting.views.
mon_alert_list
(*args, **kwargs)¶ Get (
GET
) current active alerts or filter monitoring alert history by various parameters.-
GET
/mon/alert
¶ DC-bound?: Permissions: - Admin -
dc_bound=true
- SuperAdmin -
dc_bound=false
Asynchronous?: Parameters: - data.since (timestamp) – Filter by unix timestamp, start date of the alert history (default: null => all active alerts)
- data.until (timestamp) – Filter by unix timestamp, end date of the alert history (requires
since
) (default: null) - data.last (integer) – Limit the number of current or historical alerts to fetch (default: null)
- data.show_events (boolean) – Include list of related Zabbix events and comments (default: true)
- data.vm_hostnames (array) – List of virtual server hostnames to be filtered by (default: null)
- data.vm_uuids (array) – List of virtual server UUIDs to be filtered by (default: null)
- data.node_hostnames (array) – List of compute node hostnames to be filtered by (requires
dc_bound=false
) (default: null) - data.node_uuids (array) – List of compute node UUIDs to be filtered by (requires
dc_bound=false
) (default: null) - data.dc_bound (boolean) – When true, only alerts for DC-bound objects (i.e., virtual servers) are fetched from the DC monitoring server. When false, alerts for DC-bound and DC-unbound objects (i.e, compute nodes) are fetched either from the main or from all monitoring servers across all DCs (depending on the
show_all
parameter) (requires SuperAdmin permission) (default: true) - data.show_all (boolean) – Execute as DC-unbound in the main virtual datacenter and fetch all alerts from all monitoring servers (implies
dc_bound=false
) (requires SuperAdmin permission) (default: false)
Status Codes: - 200 OK – SUCCESS
- 201 Created – PENDING
- 400 Bad Request – FAILURE
- 403 Forbidden – Forbidden
- Admin -
-