Table of Contents
获取
说明
integer/array item.get(object parameters)
此方法用于依据给定的参数检索监控项。
此方法允许所有类型的用户使用。调用此方法的权限可以在用户角色设置中撤销。更多信息请参见 用户角色 。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| itemids | string/array | 只返回给定ID的监控项。 |
| groupids | string/array | 只返回属于给定组的主机的监控项。 |
| templateids | string/array | 只返回属于给定模板的监控项。 |
| hostids | string/array | 只返回属于给定主机的监控项。 |
| proxyids | string/array | 只返回由给定Proxy监控的监控项。 |
| interfaceids | string/array | 只返回使用给定主机接口的监控项。 |
| graphids | string/array | 只返回在给定图表中使用的监控项。 |
| triggerids | string/array | 只返回在给定触发器中使用的监控项。 |
| webitems | flag | 在结果中包含web监控项。 |
| inherited | boolean | 如果设置为 true，则只返回从模板继承的监控项。 |
| templated | boolean | 如果设置为 true，则只返回属于模板的监控项。 |
| monitored | boolean | 如果设置为 true，则只返回属于监控中主机的启用监控项。 |
| group | string | 只返回属于具有给定名称的组的监控项。 |
| host | string | 只返回属于具有给定名称的主机的监控项。 |
| evaltype | integer | 标签搜索的规则。 可能的值： 0 - （默认）与/或； 2 - 或。 |
| tags | array of objects | 只返回具有给定标签的监控项。根据操作符的值，对标签进行精确匹配或对标签值进行大小写敏感或不敏感搜索。 格式： [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]。空数组返回所有监控项。 可能的操作符类型： 0 - （默认）相似； 1 - 相等； 2 - 不相似； 3 - 不相等 4 - 存在； 5 - 不存在。 |
| with_triggers | boolean | 如果设置为 true，则只返回在触发器中使用的监控项。 |
| selectHosts | query | 以数组形式返回属于监控项的主机属性。 |
| selectInterfaces | query | 返回使用该监控项的主机接口数组的接口属性。 |
| selectTriggers | query | 返回监控项所涉及的触发器数组的触发器属性。 支持 count。 |
| selectGraphs | query | 返回包含该监控项的图表数组的图表属性。 支持 count。 |
| selectDiscoveryRule | query | 返回创建该监控项的LLD规则的discoveryRule属性。 |
| selectItemDiscovery | query | 返回与从其创建的监控项原型相关联的监控项发现对象的itemDiscovery属性。它具有以下属性： itemdiscoveryid - (string) 监控项发现的ID；itemid - (string) 已发现监控项的ID；parent_itemid - (string) 从其创建监控项的监控项原型的ID；key_ - (string) 监控项原型的键；lastcheck - (timestamp) 最后发现监控项的时间；ts_delete - (timestamp) 不再发现的监控项将被删除的时间。 |
| selectPreprocessing | query | 返回包含监控项预处理选项的预处理属性。 它具有以下属性： type - (string) 预处理选项类型：1 - 自定义乘数； 2 - 右修剪； 3 - 左修剪； 4 - 修剪； 5 - 正则表达式匹配； 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。 params - (string) 预处理选项使用的附加参数。多个参数由LF ()字符分隔。error_handler - (string) 预处理步骤失败时使用的操作类型：0 - 由Zabbix服务器设置错误消息； 1 - 丢弃值； 2 - 设置自定义值； 3 - 设置自定义错误消息。 error_handler_params - (string) 错误处理参数。 |
| selectTags | query | 在tags属性中返回监控项标签。 |
| selectValueMap | query | 返回包含监控项值映射的valuemap属性。 |
| filter | object | 只返回完全匹配给定过滤器的结果。 接受一个数组，其中键是属性名称，值是单一值或要匹配的值数组。 支持额外的过滤器： host - 监控项所属主机的技术名称。 |
| limitSelects | integer | 限制子选择返回的记录数。 适用于以下子选择： selectGraphs - 结果将按 name 排序；selectTriggers - 结果将按 description 排序。 |
| sortfield | string/array | 根据给定属性对结果进行排序。 可能的值有： itemid, name, key_, delay, history, trends, type 和 status。 |
| countOutput | boolean | 这些参数对所有 get 方法都是通用的，详细描述在参考说明页面。 |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
创建一个数值类型的Zabbix agent监控项，并附加两个监控项标签，用于监控主机ID "30074" 上的空闲磁盘空间。
返回值
(integer/array) 返回其中之一：
- 一组对象；
- 如果使用了
countOutput参数，则检索对象的计数。
示例
按照关键字查找监控项
检索 ID 为 “10084” 的主机包含关键字 “系统” 一词的所有监控项，并按名称排序。
请求：
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"search": {
"key_": "system"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23298",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "Context switches per second",
"key_": "system.cpu.switches",
"delay": "1m",
"history": "7d",
"trends": "365d",
"lastvalue": "2552",
"lastclock": "1351090998",
"prevvalue": "2641",
"state": "0",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "sps",
"error": "",
"logtimefmt": "",
"templateid": "22680",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564054253",
"flags": "0",
"interfaceid": "1",
"description": "",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"parameters": []
},
{
"itemid": "23299",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU $2 time",
"key_": "system.cpu.util[,idle]",
"delay": "1m",
"history": "7d",
"trends": "365d",
"lastvalue": "86.031879",
"lastclock": "1351090999",
"prevvalue": "85.306944",
"state": "0",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"error": "",
"logtimefmt": "",
"templateid": "17354",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564256864",
"flags": "0",
"interfaceid": "1",
"description": "The time the CPU has spent doing nothing.",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"parameters": []
},
{
"itemid": "23300",
"type": "0",
"snmp_oid": "",
"hostid": "10084",
"name": "CPU $2 time",
"key_": "system.cpu.util[,interrupt]",
"history": "7d",
"trends": "365d",
"lastvalue": "0.008389",
"lastclock": "1351091000",
"prevvalue": "0.000000",
"state": "0",
"status": "0",
"value_type": "0",
"trapper_hosts": "",
"units": "%",
"error": "",
"logtimefmt": "",
"templateid": "22671",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"lastns": "564661387",
"flags": "0",
"interfaceid": "1",
"description": "The amount of time the CPU has been servicing hardware interrupts.",
"inventory_link": "0",
"lifetime": "0s",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"parameters": []
}
],
"id": 1
}按关键字查找依赖监控项
检索目标 ID 为 “10116” 的主机，包含关键字 “apache” 的所有依赖监控项。
请求：
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10116",
"search": {
"key_": "apache"
},
"filter": {
"type": "18"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "25550",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Days",
"key_": "apache.status.uptime.days",
"delay": "",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"error": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "30d",
"state": "0",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"parameters": []
},
{
"itemid": "25555",
"type": "18",
"snmp_oid": "",
"hostid": "10116",
"name": "Hours",
"key_": "apache.status.uptime.hours",
"delay": "0",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"error": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "30d",
"state": "0",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"parameters": []
}
],
"id": 1
}查找 HTTP agent 监控项
查找具有特定主机 id 的 post 正文类型 XML 的 HTTP agent 监控项。
请求：
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"hostids": "10255",
"filter": {
"type": "19",
"post_type": "3"
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28252",
"type": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "template item",
"key_": "ti",
"delay": "30s",
"history": "90d",
"trends": "365d",
"status": "0",
"value_type": "3",
"trapper_hosts": "",
"units": "",
"formula": "",
"error": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "0",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "30d",
"state": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "localhost",
"query_fields": [
{
"mode": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"http_proxy": "",
"headers": [],
"retrieve_mode": "1",
"request_method": "3",
"output_format": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"lastclock": "0",
"lastns": "0",
"lastvalue": "0",
"prevvalue": "0",
"parameters": []
}
],
"id": 3
}检索预处理规则监控项
检索 ID 为 “10254” 的主机所有监控项及其预处理规则。
请求：
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "extend",
"hostids": "10254"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"itemid": "23865",
"name": "http agent example JSON",
"key_": "json",
"preprocessing": [
{
"type": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}另请参阅
源码
ui/include/classes/api/services/CItem.php - CItem::get()