alert.get

描述

integer/array alert.get(object parameters)

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

此方法可供任何类型的用户使用。可以在用户角色设置中撤销调用此方法的权限。更多信息请参见 User roles。

参数

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

该方法支持以下参数。

Parameter Type Description
alertids ID/array 仅返回具有给定 ID 的 alert。
actionids ID/array 仅返回由给定 action 生成的 alert。
eventids ID/array 仅返回由给定 event 生成的 alert。
groupids ID/array 仅返回由给定主机组中的对象生成的 alert。
hostids ID/array 仅返回由给定主机中的对象生成的 alert。
mediatypeids ID/array 仅返回使用给定媒体类型的消息 alert。
objectids ID/array 仅返回由给定对象生成的 alert
userids ID/array 仅返回发送给给定用户的消息 alert。
eventobject integer 仅返回由与给定类型对象相关的 event 生成的 alert。

有关支持的对象类型列表，请参见 event object。

默认值：0 - trigger。
eventsource integer 仅返回由给定类型 event 生成的 alert。

有关支持的 event 类型列表，请参见 event source。

默认值：0 - trigger events。
time_from timestamp 仅返回在给定时间之后生成的 alert。
time_till timestamp 仅返回在给定时间之前生成的 alert。
selectHosts query 返回一个 hosts 属性，其中包含触发该 action operation 的主机数据。
selectMediatypes query 返回一个 mediatypes 属性，其中包含用于消息 alert 的媒体类型数组。

有关基于用户类型的限制，请参见 mediatype.get。
selectUsers query 返回一个 users 属性，其中包含消息发送对象用户的数组。

有关基于用户类型的限制，请参见 user.get。
sortfield string/array 按给定属性对结果排序。

可能的值：alertid、clock、eventid、mediatypeid、sendto、status。
countOutput boolean 这些参数在 参考说明 中有描述。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

在 Zabbix 7.0.9 中，Admin 和 User 类型用户只能检索关于其自身用户的 "message" (0) 类型 alert 数据。

返回值

(integer/array) 返回以下之一：

  • array 的 objects；
  • 如果使用了 countOutput 参数，则为检索到的 objects 的数量。

示例

按动作ID检索告警

检索由动作 "3" 生成的所有告警。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "alert.get",
    "params": {
        "output": "extend",
        "actionids": "3"
    },
    "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 中。