2.告警 - 获取告警 - 《Zabbix 5.0 使用手册》

获取告警

获取告警

描述

整数/数组 alert.get(object **parameters**)

该方式允许根据给定的参数检索警报.

参数

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

该方法支持以下参数.

参数	类型	描述
alertids	string/array	只返回给定 ID 的 alerts。
actionids	string/array	只返回给定 actions 生成的 alerts。
eventids	string/array	只返回给定事件生成的 alerts。
groupids	string/array	只返回来自指定主机组的对象生成的 alerts。
hostids	string/array	只返回来自指定主机的对象生成的 alerts。
mediatypeids	string/array	只返回用于指定报警媒介类型的消息警报。
objectids	string/array	只返回指定对象生成的 alerts。
userids	string/array	只返回发送给指定用户的消息警报。

eventobject	integer	仅返回与给定类型的对象相关的事件生成的警报。参考事件对象属性获取受支持的对象类型列表。默认值: 0 - trigger.
eventsource	integer	仅返回由给定类型的事件生成的警报。参考事件来源属性获取受支持的对象类型列表。默认值: 0 - trigger events.
time_from	timestamp	仅返回在给定时间后生成的警报。
time_till	timestamp	仅返回在给定时间之前生成的警报。

selectHosts	query	在 `hosts` 属性中返回触发 action 操作的主机。
selectMediatypes	query	在`mediatype`属性中以数组形式返回消息警报的媒体类型.
selectUsers	query	以`user`属性中的数组形式返回邮件的收件人。

sortfield	string/array	按提交参数对结果排序。可提交的参数: `alertid`, `clock`, `eventid` and `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
}

参见

来源

CAlert::get() in frontends/php/include/classes/api/services/CAlert.php.