获取

说明

integer/array itemprototype.get(object **parameters**)

此方法可以根据提供的参数获取监控项原型。

参数

(object) 参数定义期望输出

此方法提供以下参数。

属性类型描述
discoveryidsstring/array只返回属于给定LLD规则的监控项原型。
graphidsstring/array只返回在给定图标原型中使用的监控项原型。
hostidsstring/array只返回属于给定host的监控项原型。
inheritedboolean如果设为“true”，返回继承自某个模板的 监控项原型。
itemidsstring/array返回给定IDS的监控项原型。
monitoredboolean如果设为“true”，只返回已启动的属于已监控主机的监控项原型。
templatedboolean如果设为“true”，只发挥属于给定模板的监控项原型。
templateidsstring/array只返回属于给定模板的监控项原型。
triggeridsstring/array只返回使用在给定触发器原型的监控项原型。
selectApplicationsquery在applications属性中返回监控项原型所属的应用。
selectApplicationPrototypesquery只返回被连接到applicationPrototypes属性中的监控项原型的应用原型。
selectDiscoveryRulequery在discoveryRule 属性中返回图表原型所属的低级发现规则。
selectGraphsquery在graphs属性中返回被监控项原型使用的图形原型。

支持count。
selectHostsquery在hosts属性中以数组的形式返回监控项原型所属的host。
selectTriggersquery在triggers属性中返回监控项原型被使用的触发器原型。

支持count。
selectPreprocessingquery返回“预处理”属性中的项目预处理选项。
\它具有以下特性:
type - (string) 预处理选项类型:
1 -自定义乘数;
2 -右纵倾;
3 -左纵倾;
4 -修剪;
5 -正则表达式匹配;
6 -布尔值到小数;
7 -八进制到十进制;
8—十六进制到十进制;
9 -简单的改变;
10 -每秒变化;
11 - XML XPath;
12 - JSONPath;
13 - In范围;
14 -匹配正则表达式;
15 -不匹配正则表达式;
16 -检查JSON中的错误
17 -检查XML中的错误;
18 -使用正则表达式检查错误;
19 -丢弃不变的;
20 -不改变心跳丢弃;
21 - JavaScript;
22 -普罗米修斯模式;
23 -普罗米修斯到JSON;
24 - CSV到JSON;
25 -替换
params - (string)预处理选项使用的附加参数。多个参数以LF (\n)字符分隔。
errorhandler - (string)预处理步骤失败时使用的动作类型:
0 -错误信息被Zabbix服务器设置;
1 -弃值;
2 -设置自定义值;
3 -设置自定义错误信息。error_handler_params - (string)错误处理程序参数。
filterobject只返回精确匹配筛选条件的结果。

接受一个数组，数组键为属性名称，值为单个值或者数组。

支持可选筛选条件：
host - 监控项原型所属的主机的技术名称。
limitSelectsinteger限制子选择返回的记录数。

应用于如下子选择：
selectGraphs -结果将按name排序;
selectTriggers-结果将按description排序。
sortfieldstring/array根据给定的属性排序

可能的值有： itemid, name, key, delay, type 和 status.
countOutputboolean这些参数对于所有在参考说明详细描述的“get”方法都是通用的。
editableboolean
excludeSearchboolean
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回:

  • 对象数组；

  • 已获取到的对象的数量，如果countOutput参数被使用。

示例

获取监控项原型

从LLD规则中获取所有监控项原型 请求:

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

响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "itemid": "23077",
  6.             "type": "0",
  7.             "snmp_oid": "",
  8.             "hostid": "10079",
  9.             "name": "Incoming network traffic on en0",
  10.             "key_": "net.if.in[en0]",
  11.             "delay": "1m",
  12.             "history": "1w",
  13.             "trends": "365d",
  14.             "status": "0",
  15.             "value_type": "3",
  16.             "trapper_hosts": "",
  17.             "units": "bps",
  18.             "formula": "",
  19.             "error": "",
  20.             "logtimefmt": "",
  21.             "templateid": "0",
  22.             "valuemapid": "0",
  23.             "params": "",
  24.             "ipmi_sensor": "",
  25.             "authtype": "0",
  26.             "username": "",
  27.             "password": "",
  28.             "publickey": "",
  29.             "privatekey": "",
  30.             "flags": "0",
  31.             "interfaceid": "0",
  32.             "description": "",
  33.             "inventory_link": "0",
  34.             "lifetime": "30d",
  35.             "state": "0",
  36.             "evaltype": "0",
  37.             "jmx_endpoint": "",
  38.             "master_itemid": "0",
  39.             "timeout": "3s",
  40.             "url": "",
  41.             "query_fields": [],
  42.             "posts": "",
  43.             "status_codes": "200",
  44.             "follow_redirects": "1",
  45.             "post_type": "0",
  46.             "http_proxy": "",
  47.             "headers": [],
  48.             "retrieve_mode": "0",
  49.             "request_method": "0",
  50.             "output_format": "0",
  51.             "ssl_cert_file": "",
  52.             "ssl_key_file": "",
  53.             "ssl_key_password": "",
  54.             "verify_peer": "0",
  55.             "verify_host": "0",
  56.             "allow_traps": "0",
  57.             "lastclock": "0",
  58.             "lastns": "0",
  59.             "lastvalue": "0",
  60.             "prevvalue": "0",
  61.             "discover": "0"
  62.         },
  63.         {
  64.             "itemid": "10010",
  65.             "type": "0",
  66.             "snmp_oid": "",
  67.             "hostid": "10001",
  68.             "name": "Processor load (1 min average per core)",
  69.             "key_": "system.cpu.load[percpu,avg1]",
  70.             "delay": "1m",
  71.             "history": "1w",
  72.             "trends": "365d",
  73.             "status": "0",
  74.             "value_type": "0",
  75.             "trapper_hosts": "",
  76.             "units": "",
  77.             "formula": "",
  78.             "error": "",
  79.             "logtimefmt": "",
  80.             "templateid": "0",
  81.             "valuemapid": "0",
  82.             "params": "",
  83.             "ipmi_sensor": "",
  84.             "authtype": "0",
  85.             "username": "",
  86.             "password": "",
  87.             "publickey": "",
  88.             "privatekey": "",
  89.             "flags": "0",
  90.             "interfaceid": "0",
  91.             "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
  92.             "inventory_link": "0",
  93.             "lifetime": "0",
  94.             "state": "0",
  95.             "evaltype": "0",
  96.             "jmx_endpoint": "",
  97.             "master_itemid": "0",
  98.             "timeout": "3s",
  99.             "url": "",
  100.             "query_fields": [],
  101.             "posts": "",
  102.             "status_codes": "200",
  103.             "follow_redirects": "1",
  104.             "post_type": "0",
  105.             "http_proxy": "",
  106.             "headers": [],
  107.             "retrieve_mode": "0",
  108.             "request_method": "0",
  109.             "output_format": "0",
  110.             "ssl_cert_file": "",
  111.             "ssl_key_file": "",
  112.             "ssl_key_password": "",
  113.             "verify_peer": "0",
  114.             "verify_host": "0",
  115.             "allow_traps": "0",
  116.             "lastclock": "0",
  117.             "lastns": "0",
  118.             "lastvalue": "0",
  119.             "prevvalue": "0",
  120.             "discover": "0"
  121.         }
  122.     ],
  123.     "id": 1
  124. }

查找依赖的监控项

为ID为“25545”的item查找一个赖的 item。

请求:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "item.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "filter": {
  7.             "type": "18",
  8.             "master_itemid": "25545"
  9.         },
  10.         "limit": "1"
  11.     },
  12.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  13.     "id": 1
  14. }

响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "itemid": "25547",
  6.             "type": "18",
  7.             "snmp_oid": "",
  8.             "hostid": "10116",
  9.             "name": "Seconds",
  10.             "key_": "apache.status.uptime.seconds",
  11.             "delay": "0",
  12.             "history": "90d",
  13.             "trends": "365d",
  14.             "status": "0",
  15.             "value_type": "3",
  16.             "trapper_hosts": "",
  17.             "units": "",
  18.             "formula": "",
  19.             "error": "",
  20.             "logtimefmt": "",
  21.             "templateid": "0",
  22.             "valuemapid": "0",
  23.             "params": "",
  24.             "ipmi_sensor": "",
  25.             "authtype": "0",
  26.             "username": "",
  27.             "password": "",
  28.             "publickey": "",
  29.             "privatekey": "",
  30.             "flags": "0",
  31.             "interfaceid": "0",
  32.             "description": "",
  33.             "inventory_link": "0",
  34.             "lifetime": "30d",
  35.             "state": "0",
  36.             "evaltype": "0",
  37.             "master_itemid": "25545",
  38.             "jmx_endpoint": "",
  39.             "master_itemid": "0",
  40.             "timeout": "3s",
  41.             "url": "",
  42.             "query_fields": [],
  43.             "posts": "",
  44.             "status_codes": "200",
  45.             "follow_redirects": "1",
  46.             "post_type": "0",
  47.             "http_proxy": "",
  48.             "headers": [],
  49.             "retrieve_mode": "0",
  50.             "request_method": "0",
  51.             "output_format": "0",
  52.             "ssl_cert_file": "",
  53.             "ssl_key_file": "",
  54.             "ssl_key_password": "",
  55.             "verify_peer": "0",
  56.             "verify_host": "0",
  57.             "allow_traps": "0",
  58.             "lastclock": "0",
  59.             "lastns": "0",
  60.             "lastvalue": "0",
  61.             "prevvalue": "0",
  62.             "discover": "0"
  63.         }
  64.     ],
  65.     "id": 1
  66. }

查找 HTTP agent 监控项原型

为请求方法头定义的host id查找HTTP agent 监控项原型。

请求:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "itemprototype.get",
  4.     "params": {
  5.         "hostids": "10254",
  6.         "filter": {
  7.             "type": "19",
  8.             "request_method": "3"
  9.         }
  10.     },
  11.     "id": 17,
  12.     "auth": "d678e0b85688ce578ff061bd29a20d3b"
  13. }

响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "itemid": "28257",
  6.             "type": "19",
  7.             "snmp_oid": "",
  8.             "hostid": "10254",
  9.             "name": "discovered",
  10.             "key_": "item[{#INAME}]",
  11.             "delay": "{#IUPDATE}",
  12.             "history": "90d",
  13.             "trends": "30d",
  14.             "status": "0",
  15.             "value_type": "3",
  16.             "trapper_hosts": "",
  17.             "units": "",
  18.             "formula": "",
  19.             "error": "",
  20.             "logtimefmt": "",
  21.             "templateid": "28255",
  22.             "valuemapid": "0",
  23.             "params": "",
  24.             "ipmi_sensor": "",
  25.             "authtype": "0",
  26.             "username": "",
  27.             "password": "",
  28.             "publickey": "",
  29.             "privatekey": "",
  30.             "flags": "2",
  31.             "interfaceid": "2",
  32.             "description": "",
  33.             "inventory_link": "0",
  34.             "lifetime": "30d",
  35.             "state": "0",
  36.             "evaltype": "0",
  37.             "jmx_endpoint": "",
  38.             "master_itemid": "0",
  39.             "timeout": "3s",
  40.             "url": "{#IURL}",
  41.             "query_fields": [],
  42.             "posts": "",
  43.             "status_codes": "",
  44.             "follow_redirects": "0",
  45.             "post_type": "0",
  46.             "http_proxy": "",
  47.             "headers": [],
  48.             "retrieve_mode": "0",
  49.             "request_method": "3",
  50.             "output_format": "0",
  51.             "ssl_cert_file": "",
  52.             "ssl_key_file": "",
  53.             "ssl_key_password": "",
  54.             "verify_peer": "0",
  55.             "verify_host": "0",
  56.             "allow_traps": "0",
  57.             "discover": "0"
  58.         }
  59.     ],
  60.     "id": 17
  61. }

参考

来源

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