alert.get
描述
integer/array alert.get(object parameters)
该方法允许根据给定参数检索告警信息。
该方法对所有类型用户可用。调用权限可通过用户角色设置进行撤销。更多信息请参阅User roles。
参数
(object) 定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| alertids | string/array | 仅返回具有指定ID的告警。 |
| actionids | string/array | 仅返回由指定操作生成的告警。 |
| eventids | string/array | 仅返回由指定事件生成的告警。 |
| groupids | string/array | 仅返回由指定主机组中的objects生成的告警。 |
| hostids | string/array | 仅返回由指定主机中的objects生成的告警。 |
| mediatypeids | string/array | 仅返回使用了指定媒介类型的消息告警。 |
| objectids | string/array | 仅返回由指定objects生成的告警。 |
| userids | string/array | 仅返回发送给指定用户的消息告警。 |
| eventobject | integer | 仅返回由与指定类型的objects相关的事件生成的告警。 有关支持的object类型列表，请参阅事件事件。 默认值：0 - 触发器。 |
| eventsource | integer | 仅返回由指定类型的事件生成的告警。 有关支持的事件类型列表，请参阅事件事件。 默认值：0 - 触发器事件。 |
| time_from | timestamp | 仅返回在指定时间之后生成的告警。 |
| time_till | timestamp | 仅返回在指定时间之前生成的告警。 |
| selectHosts | query | 返回一个包含触发操作动作的主机数据的hosts属性。 |
| selectMediatypes | query | 返回一个包含用于消息告警的媒介类型array的mediatypes属性。 |
| selectUsers | query | 返回一个包含消息发送目标用户array的users属性。 有关基于用户类型的限制，请参阅 user.get。 |
| sortfield | string/array | 按指定属性对结果进行排序。 可能的值为： alertid, clock, eventid, mediatypeid, sendto和status。 |
| countOutput | boolean | 这些参数在通用get方法参数中有描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
在Zabbix 6.0.38中，Admin和User类型的用户只能检索关于他们自己的"message"(0)类型告警数据。
返回值
(integer/array) 返回以下两种结果之一:
- 一个包含array的objects数组
- 检索到的objects数量（当使用了
countOutput参数时）
示例
按动作ID检索告警
获取由动作"3"生成的所有告警。
请求:
{ "jsonrpc": "2.0", "method": "alert.get", "params": { "output": "extend", "actionids": "3" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }响应:
{ "jsonrpc": "2.0", "result": [ { "alertid": "1", "actionid": "3", "eventid": "21243", "userid": "1", "clock": "1362128008", "mediatypeid": "1", "sendto": "[email protected]", "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ", "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified", "status": "0", "retries": "3", "error": "", "esc_step": "1", "alerttype": "0", "p_eventid": "0", "acknowledgeid": "0" } ], "id": 1 }另请参阅
来源
CAlert::get() 位于 ui/include/classes/api/services/CAlert.php 文件中。