获取

描述

integer/array triggerprototype.get(object parameters)

此方法允许根据指定的参数检索触发器原型.

此方法适用于任何类型的用户, 调用方法的权限可以在用户角色设置中进行撤销,请参阅 用户角色了解更多信息.

参数

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

该方法支持以下参数。

参数类型描述
activeflag仅返回属于受监控主机的已启用触发器原型。
discoveryidsstring/array只返回属于给定 LLD 规则的触发器原型。
functions字符串/数组仅返回使用给定函数的触发器。

有关支持函数的列表,请参阅支持的函数页面。
groupstring仅返回属于具有给定名称的主机组中的主机的触发器原型。
groupidsstring/array仅返回属于给定主机组中主机的触发器原型。
hoststring仅返回属于具有给定名称的主机的触发器原型。
hostidsstring/array只返回属于给定主机的触发器原型。
inheritedboolean如果设置为“true”,则仅返回从模板继承的触发器原型。
maintenanceboolean如果设置为“true”,则仅返回属于维护中主机的已启用触发器原型。
min_severityinteger仅返回严重性大于或等于给定严重性的触发器原型。
monitoredflag仅返回属于受监控主机且仅包含启用项目的已启用触发器原型。
templatedboolean如果设置为“true”,则只返回属于模板的触发器原型。
templateidsstring/array只返回属于给定模板的触发器原型。
triggerids字符串/数组仅返回具有给定ID的触发器原型。
expandExpressionflag展开触发器表达式中的函数和宏。
selectDependenciesquerydependencies属性中返回触发器原型和触发器原型所依赖的触发器。
selectDiscoveryRulequery返回触发器原型所属的LLD规则
selectFunctionsqueryfunctions 属性中返回触发器原型中使用的函数。

函数对象表示触发器表达式中使用的函数,具有以下属性:
functionid - (string) 函数的 ID;
itemid - (string) 函数中使用的项目的 ID;
function - (string) 函数的名称;
parameter - (string) 传递给函数的参数。 查询参数在返回的字符串中被替换为“$”符号。
selectGroupsquerygroups 属性中返回触发器原型所属的主机组。
selectHostsqueryhosts 属性中返回触发器原型所属的主机。
selectItemsquery返回监控项和监控项原型使用 items 属性中的触发器原型。
selectTagsquery返回tags 属性中的触发器原型标签。
filterobject只返回那些与给定过滤器完全匹配的结果。

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

支持额外的过滤器:
host - 触发器原型所属主机的正式名称;
hostid - 触发器原型所属主机的 ID。
limitSelectsinteger限制子选择返回的记录数。

适用于以下子选择:
selectHosts - 结果将按 host 排序。
sortfieldstring/array按给定的属性对结果进行排序。

可能的值为:triggeriddescriptionstatuspriority
countOutputboolean参考评论 中详细描述了所有“get”方法通用的这些参数。
editableboolean
excludeSearchboolean
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回两者其中任一:

  • 一组对象.
  • 如果已经使用了countOutput参数,则检索对象的计数.

示例

从LLD规则中检索触发器原型

从底层发现规则中检索所有的触发器原型和相关函数.

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "triggerprototype.get",
  4. "params": {
  5. "output": "extend",
  6. "selectFunctions": "extend",
  7. "discoveryids": "22450"
  8. },
  9. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10. "id": 1
  11. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "triggerid": "13272",
  6. "expression": "{12598}<20",
  7. "description": "Free inodes is less than 20% on volume {#FSNAME}",
  8. "url": "",
  9. "status": "0",
  10. "priority": "2",
  11. "comments": "",
  12. "templateid": "0",
  13. "type": "0",
  14. "flags": "2",
  15. "recovery_mode": "0",
  16. "recovery_expression": "",
  17. "correlation_mode": "0",
  18. "correlation_tag": "",
  19. "manual_close": "0",
  20. "opdata": "",
  21. "discover": "0",
  22. "functions": [
  23. {
  24. "functionid": "12598",
  25. "itemid": "22454",
  26. "triggerid": "13272",
  27. "parameter": "$",
  28. "function": "last"
  29. }
  30. ]
  31. },
  32. {
  33. "triggerid": "13266",
  34. "expression": "{13500}<20",
  35. "description": "Free disk space is less than 20% on volume {#FSNAME}",
  36. "url": "",
  37. "status": "0",
  38. "priority": "2",
  39. "comments": "",
  40. "templateid": "0",
  41. "type": "0",
  42. "flags": "2",
  43. "recovery_mode": "0",
  44. "recovery_expression": "",
  45. "correlation_mode": "0",
  46. "correlation_tag": "",
  47. "manual_close": "0",
  48. "opdata": "",
  49. "discover": "0",
  50. "functions": [
  51. {
  52. "functionid": "13500",
  53. "itemid": "22686",
  54. "triggerid": "13266",
  55. "parameter": "$",
  56. "function": "last"
  57. }
  58. ]
  59. }
  60. ],
  61. "id": 1
  62. }

根据标签检索特定的触发器原型

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "triggerprototype.get",
  4. "params": {
  5. "output": [
  6. "triggerid",
  7. "description"
  8. ]
  9. "selectTags": "extend",
  10. "triggerids": [
  11. "17373"
  12. ]
  13. },
  14. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  15. "id": 1
  16. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": [
  4. {
  5. "triggerid": "17373",
  6. "description": "Free disk space is less than 20% on volume {#FSNAME}",
  7. "tags": [
  8. {
  9. "tag": "volume",
  10. "value": "{#FSNAME}"
  11. },
  12. {
  13. "tag": "type",
  14. "value": "{#FSTYPE}"
  15. }
  16. ]
  17. }
  18. ],
  19. "id": 1
  20. }

另见

源码

CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.