获取监控项原型

描述

integer/array itemprototype.get(object parameters)

该方法允许根据给定的参数检索监控项原型。

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

参数

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

该方法支持以下参数。

参数类型说明
discoveryidsstring/array只返回属于给定 LLD 规则的监控项原型。
graphidsstring/array只返回给定图形原型中使用的监控项原型。
hostidsstring/array只返回属于给定主机的监控项原型。
inheritedboolean如果设置为 true，则仅返回从模板继承的监控项原型。
itemidsstring/array只返回给定 ID 的监控项原型。
monitoredboolean如果设置为 true，则仅返回属于受监控主机的已启用监控项原型。
templatedboolean如果设置为 true，则仅返回属于模板的监控项原型。
templateidsstring/array只返回属于给定模板的监控项原型。
triggeridsstring/array只返回给定触发器原型中使用的监控项原型。
selectDiscoveryRulequery返回带有监控项原型所属的低级发现规则的 discoveryRule 属性。
selectGraphsquery返回一个 manual/api/reference/graphprototype/object#graphprototype 属性，其中包含使用监控项原型的图形原型。< br>
支持count。
selectHostsquery返回一个 hosts 属性，其中包含监控项原型所属的主机数组。
selectTagsquery返回 tags 属性中的监控项原型标签。
selectTriggersquery返回一个 triggers 属性，其中包含使用监控项原型的触发器原型。

支持count。
selectPreprocessingquery返回带有监控项预处理选项的 preprocessing 属性。

它具有以下属性：
type - (string) 预处理选项类型：
1 - 自定义乘数;
2 - 右修剪;
3 - 左修剪;
4 - 修剪;
5 - 正则表达式匹配;< br>6 - 布尔到十进制；
7 - 八进制到十进制；
8 - 十六进制到十进制；
9 - 简单更改；
10 - 每秒更改；
11 - XML XPath ;
12 - JSONPath;
13 - 在范围内;
14 - 匹配正则表达式;
15 - 不匹配正则表达式;
16 - 检查 JSON 中的错误;
17 - 检查 XML 中的错误；
18 - 使用正则表达式检查错误；
19 - 丢弃未更改；
20 - 丢弃未更改的心跳；
21 - JavaScript；
22 - Prometheus 模式；
23 - Prometheus 到 JSON；
24 - CSV 到 JSON；
25 - 替换；
26 - 检查不支持的值；
27- XML 到 JSON。<br >
params - (str ing) 预处理选项使用的附加参数。多个参数由 LF (\n) 字符分隔。
error_handler - (string) 预处理步骤失败时使用的操作类型：
0 - Zabbix 服务器设置错误消息；<br >1 - 丢弃值；
2 - 设置自定义值；
3 - 设置自定义错误消息。

error_handler_params - (string) 错误处理程序参数。
selectValueMapquery返回带有监控项原型值映射的 valuemap 属性。
filterobject只返回与给定过滤器完全匹配的结果。

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

支持额外的过滤器：
host - 监控项原型所属的主机的技术名称。
limitSelectsinteger限制子选择返回的记录数。

适用于以下子选择：
selectGraphs - 结果将按name排序；
selectTriggers - 结果将按“描述”排序。
sortfieldstring/array按给定属性对结果进行排序。

可能的值有：itemid、name、key、delay、type 和 status。
countOutputboolean这些参数对所有 get 方法都是通用的，在 参考评论 中有详细描述。
可编辑布尔
排除搜索布尔
限制整数
输出查询
preservekeys布尔值
搜索对象
searchByAny布尔值
searchWildcardsEnabled布尔值
排序字符串/数组
开始搜索布尔值

返回值

(integer/array) 返回其中之一：

  • 一个对象数组；
  • 如果使用countOutput参数，返回被检索对象的数量。

案例

返回低级别规则发现的监控项原型

返回所有低级别规则发现的监控项原型。

请求:

  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.         · "parameters": []
  63.         · },
  64.         · {
  65.         · "itemid": "10010",
  66.         · "type": "0",
  67.         · "snmp_oid": "",
  68.         · "hostid": "10001",
  69.         · "name": "Processor load (1 min average per core)",
  70.         · "key_": "system.cpu.load[percpu,avg1]",
  71.         · "delay": "1m",
  72.         · "history": "1w",
  73.         · "trends": "365d",
  74.         · "status": "0",
  75.         · "value_type": "0",
  76.         · "trapper_hosts": "",
  77.         · "units": "",
  78.         · "formula": "",
  79.         · "error": "",
  80.         · "logtimefmt": "",
  81.         · "templateid": "0",
  82.         · "valuemapid": "0",
  83.         · "params": "",
  84.         · "ipmi_sensor": "",
  85.         · "authtype": "0",
  86.         · "username": "",
  87.         · "password": "",
  88.         · "publickey": "",
  89.         · "privatekey": "",
  90.         · "flags": "0",
  91.         · "interfaceid": "0",
  92.         · "description": "The processor load is calculated as system CPU load divided by number of CPU cores.",
  93.         · "inventory_link": "0",
  94.         · "lifetime": "0",
  95.         · "state": "0",
  96.         · "evaltype": "0",
  97.         · "jmx_endpoint": "",
  98.         · "master_itemid": "0",
  99.         · "timeout": "3s",
  100.         · "url": "",
  101.         · "query_fields": [],
  102.         · "posts": "",
  103.         · "status_codes": "200",
  104.         · "follow_redirects": "1",
  105.         · "post_type": "0",
  106.         · "http_proxy": "",
  107.         · "headers": [],
  108.         · "retrieve_mode": "0",
  109.         · "request_method": "0",
  110.         · "output_format": "0",
  111.         · "ssl_cert_file": "",
  112.         · "ssl_key_file": "",
  113.         · "ssl_key_password": "",
  114.         · "verify_peer": "0",
  115.         · "verify_host": "0",
  116.         · "allow_traps": "0",
  117.         · "lastclock": "0",
  118.         · "lastns": "0",
  119.         · "lastvalue": "0",
  120.         · "prevvalue": "0",
  121.         · "discover": "0",
  122.         · "parameters": []
  123.         · }
  124.         · ],
  125.         · "id": 1
  126.        }

查找依赖监控项

查找监控项ID “25545”的依赖监控项。

请求:

  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.        }

Response:

  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.         · "parameters": []
  64.         · }
  65.         · ],
  66.         · "id": 1
  67.        }

查找HTTP代理监控项原型

通过指定主机id的请求头部方法查找HTTP代理监控项原型。

请求:

  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.         · "parameters": []
  59.         · }
  60.         · ],
  61.         · "id": 17
  62.        }

参见

来源

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