获取

描述

integer/array event.get(object parameters)

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

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

此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。参见用户角色 了解更多信息。

参数

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

该方法支持以下参数。

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

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

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

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

默认: 0 - 触发器。
acknowledged 布尔值 如果设置为 true,仅返回已确认的事件。
action 整数 仅返回已执行给定 事件更新操作 的事件。对于多个操作,使用任何可接受的位图值之和作为位掩码(例如,34 表示确认和抑制事件)。
action_userids ID/数组 仅返回具有给定用户ID的事件,这些用户执行了事件更新操作。
suppressed 布尔值 true - 仅返回已抑制的事件;
false - 返回处于正常状态的事件。
symptom 布尔值 true - 仅返回症状事件;
false - 仅返回原因事件。
severities 整数/数组 仅返回具有给定事件严重性的事件。仅在对象为触发器时适用。
trigger_severities 整数/数组 仅返回具有给定触发器严重性的事件。仅在对象为触发器时适用。
evaltype 整数 用于标签搜索的规则。

可能的值:
0 - (默认)与/或;
2 - 或。
tags 数组 仅返回具有给定标签的事件。标签完全匹配,值和运算符大小写不敏感搜索。
格式: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]
空数组返回所有事件。

可能的运算符类型:
0 - (默认)类似;
1 - 等于;
2 - 不类似;
3 - 不等于
4 - 存在;
5 - 不存在。
eventid_from 字符串 仅返回ID大于或等于给定ID的事件。
eventid_till 字符串 仅返回ID小于或等于给定ID的事件。
time_from 时间戳 仅返回在给定时间之后或在该时间创建的事件。
time_till 时间戳 仅返回在给定时间之前或在该时间创建的事件。
problem_time_from 时间戳 仅返回从 problem_time_from 开始处于问题状态的事件。仅在源为触发器事件且对象为触发器时适用。如果指定了 problem_time_till,则为必填项。
problem_time_till 时间戳 仅返回直到 problem_time_till 处于问题状态的事件。仅在源为触发器事件且对象为触发器时适用。如果指定了 problem_time_from,则为必填项。
value 整数/数组 仅返回具有给定值的事件。
selectAcknowledges 查询 返回一个 acknowledges 属性,其中包含事件更新。事件更新按逆时间顺序排序。

事件更新对象具有以下属性:
acknowledgeid - (ID) 确认的ID;
userid - (ID) 更新事件的用户ID;
clock - (时间戳) 事件更新的时间;
message - (字符串) 消息的文本;
action - (整数) 执行的更新操作,参见 event.acknowledge;
old_severity - (整数) 此更新操作之前的事件严重性;
new_severity - (整数) 此更新操作之后的事件严重性;
suppress_until - (时间戳) 事件将被抑制的时间;
taskid - (ID) 如果当前事件正在经历等级变化,则为任务ID;
username - (字符串) 更新事件的用户名;
name - (字符串) 更新事件的用户名称;
surname - (字符串) 更新事件的用户姓氏。

支持 count
selectAlerts 查询 返回一个 alerts 属性,其中包含由事件生成的警报。警报按逆时间顺序排序。
selectHosts 查询 返回一个包含生成事件的对象所在的主机的属性 hosts。仅支持由触发器、监控项或LLD规则生成的事件。
selectRelatedObject 查询 返回一个 relatedObject 属性,其中包含创建事件的对象。返回的对象类型取决于事件类型。
selectSuppressionData 查询 返回一个 suppression_data 属性,其中包含活动维护和手动抑制的列表:
maintenanceid - (ID) 维护的ID;
userid - (ID) 抑制事件的用户ID;
suppress_until - (整数) 事件被抑制的时间。
selectTags 查询 返回一个包含事件标签的属性 tags
filter 对象 仅返回与给定过滤器完全匹配的结果。

接受一个对象,其中键是属性名称,值是用于匹配的单个值或值数组。

不支持 text 数据类型 的属性。
sortfield 字符串/数组 根据给定属性对结果进行排序。

可能的值: eventid, objectid, clock

groupBy 一起使用时的可能值: objectid

countOutputgroupBy 一起使用时的可能值: objectid, rowscount
groupBy 字符串/数组 根据给定属性对结果进行分组。指定的属性将包含在结果中。

可能的值: objectid
countOutput 布尔值 这些参数在 参考说明 中有描述。
editable 布尔值
excludeSearch 布尔值
limit 整数
output 查询
preservekeys 布尔值
search 对象
searchByAny 布尔值
searchWildcardsEnabled 布尔值
sortorder 字符串/数组
startSearch 布尔值
select_acknowledges
(已废弃)
查询 此参数已废弃,请改用 selectAcknowledges
返回一个 acknowledges 属性,其中包含事件更新。
事件更新按逆时间顺序排序。

事件更新对象具有以下属性:
acknowledgeid - (ID) 确认的ID;
userid - (ID) 更新事件的用户ID;
clock - (时间戳) 事件更新的时间;
message - (字符串) 消息的文本;
action - (整数) 执行的更新操作,参见 event.acknowledge;
old_severity - (整数) 此更新操作之前的事件严重性;
new_severity - (整数) 此更新操作之后的事件严重性;
suppress_until - (时间戳) 事件将被抑制的时间;
taskid - (ID) 如果当前事件正在经历等级变化,则为任务ID;
username - (字符串) 更新事件的用户名;
name - (字符串) 更新事件的用户名称;
surname - (字符串) 更新事件的用户姓氏。

支持 count
select_alerts
(已废弃)
查询 此参数已废弃,请改用 selectAlerts
返回一个包含由事件生成的警报的属性 [alerts](/manual/api/reference/alert/object)
警报按逆时间顺序排序。

返回值

(integer/array) 返回其中一种结果:

  • 一个对象数组;
  • 如果已使用countOutput参数,但未使用groupBy参数,则为检索到的对象的计数;
  • 如果使用了groupBy参数,则为具有聚合结果的对象数组。

示例

获取触发器事件

检索触发器“22395”的最新事件。

请求:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "selectAcknowledges": "extend",
               "selectSuppressionData": "extend",
               "selectTags": "extend",
               "objectids": "22395",
               "sortfield": ["clock", "eventid"],
               "sortorder": "DESC"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "20",
                   "source": "0",
                   "object": "0",
                   "objectid": "22395",
                   "clock": "1728658089",
                   "value": "0",
                   "acknowledged": "0",
                   "ns": "461809482",
                   "name": "平均负载过高(每CPU负载5分钟内超过1.5)",
                   "severity": "0",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "acknowledges": [],
                   "opdata": "平均负载(1m 5m 15m): (1.6328 3.0522 2.2515),CPU数量: 2",
                   "suppression_data": [],
                   "suppressed": "0",
                   "tags": [
                       {
                           "tag": "scope",
                           "value": "capacity"
                       },
                       {
                           "tag": "scope",
                           "value": "performance"
                       },
                       {
                           "tag": "component",
                           "value": "cpu"
                       },
                       {
                           "tag": "class",
                           "value": "os"
                       },
                       {
                           "tag": "target",
                           "value": "linux"
                       }
                   ],
                   "urls": []
               },
               {
                   "eventid": "4",
                   "source": "0",
                   "object": "0",
                   "objectid": "22395",
                   "clock": "1728657737",
                   "value": "1",
                   "acknowledged": "1",
                   "ns": "460759366",
                   "name": "平均负载过高(每CPU负载5分钟内超过1.5)",
                   "severity": "3",
                   "r_eventid": "20",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "acknowledges": [
                       {
                           "acknowledgeid": "1",
                           "userid": "1",
                           "clock": "1728657938",
                           "message": "测试环境。请忽略此警报。",
                           "action": "38",
                           "old_severity": "0",
                           "new_severity": "0",
                           "suppress_until": "1728744338",
                           "taskid": "0",
                           "username": "管理员",
                           "name": "Zabbix",
                           "surname": "管理员"
                       }
                   ],
                   "opdata": "平均负载(1m 5m 15m): (1.6328 3.0522 2.2515),CPU数量: 2",
                   "suppression_data": [
                       {
                           "maintenanceid": "0",
                           "suppress_until": "1728744338",
                           "userid": "1"
                       }
                   ],
                   "suppressed": "1",
                   "tags": [
                       {
                           "tag": "scope",
                           "value": "capacity"
                       },
                       {
                           "tag": "scope",
                           "value": "performance"
                       },
                       {
                           "tag": "component",
                           "value": "cpu"
                       },
                       {
                           "tag": "class",
                           "value": "os"
                       },
                       {
                           "tag": "target",
                           "value": "linux"
                       }
                   ],
                   "urls": []
               }
           ],
           "id": 1
       }

按时间周期检索事件

检索2012年10月17日至18日之间创建的所有事件,按时间逆序排列。

请求:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "time_from": "1350432000",
               "time_till": "1350518400",
               "sortfield": ["clock", "eventid"],
               "sortorder": "DESC"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "20617",
                   "source": "0",
                   "object": "0",
                   "objectid": "14282",
                   "clock": "1350477816",
                   "value": "1",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "历史缓存中剩余空间少于25%",
                   "severity": "3",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0",
                   "urls": []
               },
               {
                   "eventid": "20616",
                   "source": "0",
                   "object": "0",
                   "objectid": "14281",
                   "clock": "1350477814",
                   "value": "0",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "Zabbix trapper进程繁忙程度超过75%",
                   "severity": "0",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0",
                   "urls": []
               },
               {
                   "eventid": "20615",
                   "source": "0",
                   "object": "0",
                   "objectid": "14281",
                   "clock": "1350477541",
                   "value": "1",
                   "acknowledged": "0",
                   "ns": "0",
                   "name": "Zabbix trapper进程繁忙程度超过75%",
                   "severity": "3",
                   "r_eventid": "20616",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "opdata": "",
                   "suppressed": "0",
                   "urls": []
               }
           ],
           "id": 1
       }

获取指定用户确认的事件

获取由用户ID=10确认的事件

请求:

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "output": "extend",
               "action": 2,
               "action_userids": [10],
               "selectAcknowledges": ["userid", "action"],
               "sortfield": ["eventid"],
               "sortorder": "DESC"
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "eventid": "503",
                   "source": "0",
                   "object": "0",
                   "objectid": "23162",
                   "clock": "1747212236",
                   "value": "1",
                   "acknowledged": "1",
                   "ns": "413470863",
                   "name": "已安装软件包的数量已更改",
                   "severity": "2",
                   "r_eventid": "0",
                   "c_eventid": "0",
                   "correlationid": "0",
                   "userid": "0",
                   "cause_eventid": "0",
                   "acknowledges": [
                       {
                           "userid": "10",
                           "action": "2"
                       }
                   ],
                   "opdata": "",
                   "suppressed": "0",
                   "urls": []
               }
           ],
           "id": 1
       }

检索具有问题事件计数的顶级触发器

检索严重程度为"Warning", "Average", "High", or "Disaster"的前5个触发器,以及指定时间段内的问题事件数。

请求

{
           "jsonrpc": "2.0",
           "method": "event.get",
           "params": {
               "countOutput": true,
               "groupBy": "objectid",
               "source": 0,
               "object": 0,
               "value": 1,
               "time_from": 1672531200,
               "time_till": 1677628800,
               "trigger_severities": [2, 3, 4, 5],
               "sortfield": ["rowscount"],
               "sortorder": "DESC",
               "limit": 5
           },
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "objectid": "232124",
                   "rowscount": "27"
               },
               {
                   "objectid": "29055",
                   "rowscount": "23"
               },
               {
                   "objectid": "253731",
                   "rowscount": "18"
               },
               {
                   "objectid": "254062",
                   "rowscount": "11"
               },
               {
                   "objectid": "23216",
                   "rowscount": "7"
               }
           ],
           "id": 1
       }

参见

来源

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