获取

获取

描述

integer/array alert.get(object parameters)

该方法允许根据给定的参数检索告警。

此方法对于任何用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色。

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数	类型	描述
alertids	string/array	仅返回给定 ID 的告警。
actionids	string/array	仅返回给定动作生成的告警。
eventids	string/array	仅返回给定事件生成的告警。
groupids	string/array	仅返回来自指定主机组的对象生成的告警。
hostids	string/array	仅返回来自指定主机的对象生成的告警。
mediatypeids	string/array	仅返回使用给定媒介类型的消息告警。
objectids	string/array	仅返回指定对象生成的告警。
userids	string/array	仅返回发送给指定用户的消息告警。
eventobject	integer	仅返回由与给定类型的对象相关的事件生成的告警。参考 event “object” 获取受支持的对象类型列表。默认： 0 - 触发器。
eventsource	integer	仅返回由给定类型的事件生成的告警。参考 event “source” 获取受支持的事件类型列表。默认： 0 - 触发器事件。
time_from	timestamp	仅返回在给定时间之后生成的告警。
time_till	timestamp	仅返回在给定时间之前生成的告警。
selectHosts	query	在 hosts 属性中返回触发动作操作的主机。
selectMediatypes	query	在 mediatypes 属性中以数组形式返回消息告警的媒介类型。
selectUsers	query	在 users 属性中以数组形式返回消息发送到的用户。
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

返回值

(integer/array) 返回以下任一选项：

对象数组；
如果使用了 countOutput 参数，则检索对象的计数。

示例

通过动作 ID 检索告警

返回所有动作 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
       }

参见

来源

ui/include/classes/api/services/CAlert.php 中的 CAlert::get()。