获取

描述

integer/array event.get(object parameters)

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

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

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

参数

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

此方法支持以下参数。

参数类型描述
eventidsID/array仅返回具有给定 ID 的事件。
groupidsID/array仅返回由属于给定主机组的对象创建的事件。
hostidsID/array仅返回由属于给定主机的对象创建的事件。
objectidsID/array仅返回由给定对象创建的事件。
sourceinteger仅返回给定类型的事件。

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

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

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

默认值:0 - 触发器。
acknowledgedboolean如果设置为 true,仅返回已确认的事件。
actioninteger仅返回已执行给定事件更新动作 的事件。 对于多个操作,请使用任何可接受的位图值的组合作为位掩码。
action_useridsID/array仅返回具有执行事件更新操作的用户的给定ID的事件。
suppressedbooleantrue - 返回被抑制的事件;
false - 仅返回正常状态的事件。
symptombooleantrue - 仅返回症状事件;
false - 仅返回导致事件。
severitiesinteger/array仅返回具有给定事件严重性的事件。仅当对象是触发器时适用。
trigger_severitiesinteger/array仅返回具有给定触发严重性的事件。仅当对象是触发器时适用。
evaltypeinteger标签搜索规则。

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

可能的运算符类型:
0 - (默认) Like(类似于……);
1 - Equal(等于);
2 - Not like(不类似于……);
3 - Not equal(不等于);
4 - Exists(存在);
5 - Not exists(不存在)。
eventid_fromstring仅返回 ID 大于或等于给定 ID 的事件。
eventid_tillstring仅返回 ID 小于或等于给定 ID 的事件。
time_fromtimestamp仅返回在给定时间或在给定时间之后创建的事件。
time_tilltimestamp仅返回在给定时间或在给定时间之前创建的事件。
problem_time_fromtimestamp仅返回从problem_time_from设定的时间开始处于问题状态的事件。仅当事件源是触发器事件且对象为触发时适用。如果指定了 problem_time_till,则为必填项。
problem_time_tilltimestamp仅返回在problem_time_still设定的时间之前处于问题状态的事件。仅当事件源是触发器事件且对象为触发时适用。如果指定了 problem_time_from,则为必填项。
valueinteger/array仅返回具有给定值的事件。
selectAcknowledgesquery返回带有事件更新的 acknowledges 属性。事件更新按时间倒序排列。

事件更新对象具有以下属性:
acknowledgeid - (ID) 确认事件的ID;
userid - (ID) 更新事件的用户ID;
clock - (timestamp) 事件被更新的时间;
message - (string) 消息文本;
action - (integer) 更新执行的操作,参见 event.acknowledge
old_severity - (integer) 此更新操作之前的事件严重性;
new_severity - (integer) 此更新操作后的事件严重性;
suppress_until - (timestamp) 事件被抑制之前的时间;
taskid - (ID) 如果当前事件正在进行等级更改,则为任务的ID;
username - (string) 更新该事件的用户的username(用户名);
name - (string) 更新该事件的用户的name(可见名);
surname - (string) 更新事件的用户的surname(姓)。

支持 count
selectAlertsquery返回由事件生成的告警的 告警 属性。告警按时间倒序排列。
selectHostsquery返回 主机 属性,其中 hosts 包含创建事件的对象。仅支持由触发器、监控项或 LLD 规则生成的事件。
selectRelatedObjectquery返回带有创建事件的对象的 relatedObject 属性。返回的对象类型取决于事件类型。
selectSuppressionDataquery返回维护列表的suppression_data 属性:
maintenanceid - (ID) 维护的ID;
suppress_until - (integer) 直到事件被抑制的时间。
selectTagsquery返回事件标签的 标签 属性。
filterobject仅返回与给定过滤器完全匹配的结果。

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

不支持 text 数据类型的属性。
sortfieldstring/array按给定属性对结果进行排序。

可能值:eventidobjectidclock

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

countOutputgroupBy一起使用的可能值: objectidrowscount
groupBystring/array根据给定的属性对结果进行分组。指定的属性将在结果中返回。

可能值:objectid
countOutputboolean这些参数对所有get方法都是通用的,详细描述请参见 参考说明
editableboolean
excludeSearchboolean
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean
select_acknowledges(已弃用)query此参数已弃用,请改用 selectAcknowledges
返回带有事件更新的 acknowledges 属性。事件更新按时间倒序排列。

事件更新对象具有以下属性:
acknowledgeid - (ID) 确认事件的ID;
userid - (ID) 更新事件的用户ID;
clock - (timestamp) 事件被更新的时间;
message - (string) 消息文本;
action - (integer) 更新执行的操作,参见 event.acknowledge
old_severity - (integer) 此更新操作之前的事件严重性;
new_severity - (integer) 此更新操作后的事件严重性;
suppress_until - (timestamp) 事件被抑制之前的时间;
taskid - (ID) 如果当前事件正在进行等级更改,则为任务的ID;
username - (string) 更新该事件的用户的username(用户名);
name - (string) 更新该事件的用户的name(可见名);
surname - (string) 更新事件的用户的surname(姓)。

支持 count
select_alerts(已弃用)query此参数已弃用,请改用selectAlerts
返回由事件生成的告警的 告警 属性。告警按时间倒序排列。

返回值

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

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

示例

检索触发器事件

检索ID为 “13926” 的触发器的最新事件。

请求

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "event.get",
  4. "params": {
  5. "output": "extend",
  6. "selectAcknowledges": "extend",
  7. "selectSuppressionData": "extend",
  8. "selectTags": "extend",
  9. "objectids": "13926",
  10. "sortfield": ["clock", "eventid"],
  11. "sortorder": "DESC"
  12. },
  13. "id": 1
  14. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "eventid": "9695",
  6. "source": "0",
  7. "object": "0",
  8. "objectid": "13926",
  9. "clock": "1347970410",
  10. "value": "1",
  11. "acknowledged": "1",
  12. "ns": "413316245",
  13. "name": "MySQL is down",
  14. "severity": "5",
  15. "r_eventid": "0",
  16. "c_eventid": "0",
  17. "correlationid": "0",
  18. "userid": "0",
  19. "cause_eventid": "0",
  20. "acknowledges": [
  21. {
  22. "acknowledgeid": "1",
  23. "userid": "1",
  24. "clock": "1350640590",
  25. "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
  26. "action": "6",
  27. "old_severity": "0",
  28. "new_severity": "0",
  29. "suppress_until": "1472511600",
  30. "taskid": "0",
  31. "username": "Admin",
  32. "name": "Zabbix",
  33. "surname": "Administrator"
  34. }
  35. ],
  36. "opdata": "",
  37. "suppression_data": [
  38. {
  39. "maintenanceid": "15",
  40. "suppress_until": "1472511600",
  41. "userid": "0"
  42. }
  43. ],
  44. "suppressed": "1",
  45. "tags": [
  46. {
  47. "tag": "service",
  48. "value": "mysqld"
  49. },
  50. {
  51. "tag": "error",
  52. "value": ""
  53. }
  54. ],
  55. "urls": []
  56. },
  57. {
  58. "eventid": "9671",
  59. "source": "0",
  60. "object": "0",
  61. "objectid": "13926",
  62. "clock": "1347970347",
  63. "value": "0",
  64. "acknowledged": "0",
  65. "ns": "0",
  66. "name": "Unavailable by ICMP ping",
  67. "severity": "4",
  68. "r_eventid": "0",
  69. "c_eventid": "0",
  70. "correlationid": "0",
  71. "userid": "0",
  72. "cause_eventid": "0",
  73. "acknowledges": [],
  74. "opdata": "",
  75. "suppression_data": [],
  76. "suppressed": "0",
  77. "tags": [],
  78. "urls": []
  79. }
  80. ],
  81. "id": 1
  82. }

按时间段检索事件

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

请求

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "event.get",
  4. "params": {
  5. "output": "extend",
  6. "time_from": "1349797228",
  7. "time_till": "1350661228",
  8. "sortfield": ["clock", "eventid"],
  9. "sortorder": "desc"
  10. },
  11. "id": 1
  12. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "eventid": "9695",
  6. "source": "0",
  7. "object": "0",
  8. "objectid": "13926",
  9. "clock": "1347970410",
  10. "value": "1",
  11. "acknowledged": "1",
  12. "ns": "413316245",
  13. "name": "MySQL is down",
  14. "severity": "5",
  15. "r_eventid": "0",
  16. "c_eventid": "0",
  17. "correlationid": "0",
  18. "userid": "0",
  19. "cause_eventid": "0",
  20. "acknowledges": [
  21. {
  22. "acknowledgeid": "1",
  23. "userid": "1",
  24. "clock": "1350640590",
  25. "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
  26. "action": "6",
  27. "old_severity": "0",
  28. "new_severity": "0",
  29. "suppress_until": "1472511600",
  30. "taskid": "0",
  31. "username": "Admin",
  32. "name": "Zabbix",
  33. "surname": "Administrator"
  34. }
  35. ],
  36. "opdata": "",
  37. "suppression_data": [
  38. {
  39. "maintenanceid": "15",
  40. "suppress_until": "1472511600",
  41. "userid": "0"
  42. }
  43. ],
  44. "suppressed": "1",
  45. "tags": [
  46. {
  47. "tag": "service",
  48. "value": "mysqld"
  49. },
  50. {
  51. "tag": "error",
  52. "value": ""
  53. }
  54. ],
  55. "urls": []
  56. },
  57. {
  58. "eventid": "9671",
  59. "source": "0",
  60. "object": "0",
  61. "objectid": "13926",
  62. "clock": "1347970347",
  63. "value": "0",
  64. "acknowledged": "0",
  65. "ns": "0",
  66. "name": "Unavailable by ICMP ping",
  67. "severity": "4",
  68. "r_eventid": "0",
  69. "c_eventid": "0",
  70. "correlationid": "0",
  71. "userid": "0",
  72. "cause_eventid": "0",
  73. "acknowledges": [],
  74. "opdata": "",
  75. "suppression_data": [],
  76. "suppressed": "0",
  77. "tags": [],
  78. "urls": []
  79. }
  80. ],
  81. "id": 1
  82. }

检索指定用户确认的事件

正在检索ID为10的用户确认的事件

请求

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "event.get",
  4. "params": {
  5. "output": "extend",
  6. "action": 2,
  7. "action_userids": [10],
  8. "selectAcknowledges": ["userid", "action"],
  9. "sortfield": ["eventid"],
  10. "sortorder": "DESC"
  11. },
  12. "id": 1
  13. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "eventid": "1248566",
  6. "source": "0",
  7. "object": "0",
  8. "objectid": "15142",
  9. "clock": "1472457242",
  10. "ns": "209442442",
  11. "r_eventid": "1245468",
  12. "r_clock": "1472457285",
  13. "r_ns": "125644870",
  14. "correlationid": "0",
  15. "userid": "10",
  16. "name": "Zabbix agent on localhost is unreachable for 5 minutes",
  17. "acknowledged": "1",
  18. "severity": "3",
  19. "cause_eventid": "0",
  20. "acknowledges": [
  21. {
  22. "userid": "10",
  23. "action": "2"
  24. }
  25. ],
  26. "opdata": "",
  27. "suppressed": "0",
  28. "urls": []
  29. }
  30. ],
  31. "id": 1
  32. }

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

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

请求

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "event.get",
  4. "params": {
  5. "countOutput": true,
  6. "groupBy": "objectid",
  7. "source": 0,
  8. "object": 0,
  9. "value": 1,
  10. "time_from": 1672531200,
  11. "time_till": 1677628800,
  12. "trigger_severities": [2, 3, 4, 5],
  13. "sortfield": ["rowscount"],
  14. "sortorder": "DESC",
  15. "limit": 5
  16. },
  17. "id": 1
  18. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "objectid": "232124",
  6. "rowscount": "27"
  7. },
  8. {
  9. "objectid": "29055",
  10. "rowscount": "23"
  11. },
  12. {
  13. "objectid": "253731",
  14. "rowscount": "18"
  15. },
  16. {
  17. "objectid": "254062",
  18. "rowscount": "11"
  19. },
  20. {
  21. "objectid": "23216",
  22. "rowscount": "7"
  23. }
  24. ],
  25. "id": 1
  26. }

参见

来源

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