这是原厂英文文档的翻译页面. 欢迎帮助我们 完善文档.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

获取

描述

integer/array event.get(object parameters)

该方法允许根据给定的参数检索事件。

如果管家尚未删除这些事件,则此方法可能会返回已删除实体的事件。

此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。查看 用户角色

参数

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

此方法支持以下参数。

参数 类型 描述
eventids string/array 仅返回具有给定 ID 的事件。
groupids string/array 仅返回由属于给定主机组的对象创建的事件。
hostids string/array 仅返回由属于给定主机的对象创建的事件。
objectids string/array 仅返回由给定对象创建的事件。
source integer 仅返回给定类型的事件。

参阅 事件对象页面 获取支持的事件类型列表。

默认值:0 - 触发器事件。
object integer 仅返回由给定类型的对象创建的事件。

参阅 事件对象页面 获取支持的事件类型列表。

默认值:0 - 触发器。
acknowledged boolean 如果设置为 true 仅返回已确认的事件。
suppressed boolean true - 只返回被抑制的事件;
false - 返回正常状态的事件。
severities integer/array 仅返回具有给定严重性的事件。仅当对象是触发器时才适用。
evaltype integer 标签搜索规则。

可用值:
0 - (默认)和/或;
2 - 或。
tags 对象数组 仅返回具有给定标签的事件。通过标签进行精确匹配,通过值和操作符进行不区分大小写的匹配。
格式:[{"tag":"<tag>", "value":"<value>","operator":"<operator>"},...]
空数组返回所有事件。

可能的运算符类型:
0 - (默认) Like(类似于……);
1 - Equal(等于);
2 - Not like(不类似于……);
3 - Not equal(不等于);
4 - Exists(存在);
5 - Not exists(不存在)。
eventid_from string 仅返回 ID 大于或等于给定 ID 的事件。
eventid_till string 仅返回 ID 小于或等于给定 ID 的事件。
time_from timestamp 仅返回在给定时间或在给定时间之后创建的事件。
time_till timestamp 仅返回在给定时间或在给定时间之前创建的事件。
problem_time_from timestamp 仅返回从problem_time_from设定的时间开始处于问题状态的事件。仅当事件源是触发器事件且对象为触发时适用。如果指定了 problem_time_till ,则为强制性。
problem_time_till timestamp 仅返回在problem_time_still设定的时间之前处于问题状态的事件。仅当事件源是触发器事件且对象为触发时适用。如果指定了 problem_time_from ,则为强制性。
value integer/array 仅返回具有给定值的事件。
selectHosts query 返回 主机 属性,其中 hosts 包含创建事件的对象。仅支持由触发器、监控项或 LLD 规则生成的事件。
selectRelatedObject query 返回带有创建事件的对象的 'relatedObject ' 属性。返回的对象类型取决于事件类型。
select_alerts query 返回由事件生成的告警的 告警 属性。警报按时间倒序排列。
select_acknowledges query 返回带有事件更新的 acknowledges 属性。 事件更新按时间倒序排列。

事件更新对象具有以下属性:
acknowledgeid - (string) 确认事件的ID;
userid - (string) 更新事件的用户ID;
eventid - (string) 更新事件的ID;
clock - (timestamp) 事件被更新的时间;
message - (string) 消息文本;
action - (integer) 更新执行的操作,参见 event.acknowledge
old_severity - (integer) 此更新操作之前的事件严重性;
new_severity - (integer) 此更新操作后的事件严重性;
username - (string) 更新该事件的用户的username(用户名);
name - (string) 更新该事件的用户的name(可见名);
surname - (string) 更新事件的用户的surname(姓)。

支持 count
selectTags query 返回事件标签的 标签 属性。
selectSuppressionData query 返回维护列表的suppression_data 属性:
maintenanceid - (string) 维护期ID;
suppress_until - (integer) 事件被抑制的时间。
sortfield string/array 按给定属性对结果进行排序。

可用值:eventidobjectidclock
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为 "13926" 的触发器的最新事件。

请求:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
           "output": "extend",
           "select_acknowledges": "extend",
           "selectTags": "extend",
           "selectSuppressionData": "extend",
           "objectids": "13926",
           "sortfield": ["clock", "eventid"],
           "sortorder": "DESC"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
           {
           "eventid": "9695",
           "source": "0",
           "object": "0",
           "objectid": "13926",
           "clock": "1347970410",
           "value": "1",
           "acknowledged": "1",
           "ns": "413316245",
           "name": "MySQL is down",
           "severity": "5",
           "r_eventid": "0",
           "c_eventid": "0",
           "correlationid": "0",
           "userid": "0",
           "opdata": "",
           "acknowledges": [
           {
           "acknowledgeid": "1",
           "userid": "1",
           "eventid": "9695",
           "clock": "1350640590",
           "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
           "action": "6",
           "old_severity": "0",
           "new_severity": "0",
           "username": "Admin",
           "name": "Zabbix",
           "surname": "Administrator"
           }
           ],
           "suppression_data": [
           {
           "maintenanceid": "15",
           "suppress_until": "1472511600"
           }
           ],
           "suppressed": "1",
           "tags": [
           {
           "tag": "service",
           "value": "mysqld"
           },
           {
           "tag": "error",
           "value": ""
           }
           ]
           },
           {
           "eventid": "9671",
           "source": "0",
           "object": "0",
           "objectid": "13926",
           "clock": "1347970347",
           "value": "0",
           "acknowledged": "0",
           "ns": "0",
           "name": "Unavailable by ICMP ping",
           "severity": "4",
           "r_eventid": "0",
           "c_eventid": "0",
           "correlationid": "0",
           "userid": "0",
           "opdata": "",
           "acknowledges": [],
           "suppression_data": [],
           "suppressed": "0",
           "tags": []
           }
           ],
           "id": 1
       }

按时间段检索事件

按时间倒序检索在 2012 年 10 月 9 日至 10 日之间创建的所有事件。

请求:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
           "output": "extend",
           "time_from": "1349797228",
           "time_till": "1350661228",
           "sortfield": ["clock", "eventid"],
           "sortorder": "desc"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
           {
           "eventid": "20616",
           "source": "0",
           "object": "0",
           "objectid": "14282",
           "clock": "1350477814",
           "value": "1",
           "acknowledged": "0",
           "ns": "0",
           "name": "Less than 25% free in the history cache",
           "severity": "3",
           "r_eventid": "0",
           "c_eventid": "0",
           "correlationid": "0",
           "userid": "0",
           "opdata": "",
           "suppressed": "0"
           },
           {
           "eventid": "20617",
           "source": "0",
           "object": "0",
           "objectid": "14283",
           "clock": "1350477814",
           "value": "0",
           "acknowledged": "0",
           "ns": "0",
           "name": "Zabbix trapper processes more than 75% busy",
           "severity": "3",
           "r_eventid": "0",
           "c_eventid": "0",
           "correlationid": "0",
           "userid": "0",
           "opdata": "",
           "suppressed": "0"
           },
           {
           "eventid": "20618",
           "source": "0",
           "object": "0",
           "objectid": "14284",
           "clock": "1350477815",
           "value": "1",
           "acknowledged": "0",
           "ns": "0",
           "name": "High ICMP ping loss",
           "severity": "3",
           "r_eventid": "0",
           "c_eventid": "0",
           "correlationid": "0",
           "userid": "0",
           "opdata": "",
           "suppressed": "0"
           }
           ],
           "id": 1
       }

参见

来源

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