我的书签
添加书签
移除书签获取
描述
integer/array itemprototype.get(object parameters)
该方法允许根据给定的参数检索监控项原型。
任何类型的用户都可以使用此方法。权限可以在用户角色设置中撤消调用该方法。了解更多信息可以参见用户角色。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 描述 |
|---|---|---|
| discoveryids | ID/array | 只返回属于给定LLD规则的监控项原型。 |
| graphids | ID/array | 只返回在给定图表原型中使用的监控项原型。 |
| hostids | ID/array | 只返回属于给定主机的监控项原型。 |
| inherited | boolean | 如果设置为true，则只返回从模板继承的监控项原型。 |
| itemids | ID/array | 只返回具有给定ID的监控项原型。 |
| monitored | boolean | 如果设置为true，则只返回属于被监控主机的启用的监控项原型。 |
| templated | boolean | 如果设置为true，则只返回属于模板的监控项原型。 |
| templateids | ID/array | 只返回属于给定模板的监控项原型。 |
| triggerids | ID/array | 只返回在给定触发器原型中使用的监控项原型。 |
| selectDiscoveryRule | query | 返回一个discoveryRule属性，包含监控项原型所属的低级发现规则。 |
| selectGraphs | query | 返回一个graphs属性，包含监控项原型使用的图表原型。 支持 count。 |
| selectHosts | query | 返回一个hosts属性，包含监控项原型所属的主机数组。 |
| selectTags | query | 返回tags属性中的监控项原型标签。 |
| selectTriggers | query | 返回一个triggers属性，包含监控项原型使用的触发器原型。 支持 count。 |
| selectPreprocessing | query | 返回一个preprocessing属性，包含监控项原型预处理选项。 |
| selectValueMap | query | 返回一个valuemap属性，包含监控项原型的值映射。 |
| filter | object | 只返回完全符合给定过滤器的结果。 接受一个对象，其中键是属性名称，值是单一值或要匹配的值数组。 不支持 text 数据类型的属性。支持额外属性： host - 监控项原型所属的主机的技术名称。 |
| limitSelects | integer | 限制子选择返回的记录数。 适用于以下子选择： selectGraphs - 结果将按name排序；selectTriggers - 结果将按description排序。 |
| sortfield | string/array | 根据给定属性对结果进行排序。 可能的值： itemid, name, key_, delay, 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 |
返回值
(integer/array) 返回其中之一：
- 一个对象数组；
- 如果使用
countOutput参数，返回被检索对象的数量。
示例
从LLD规则中检索监控项原型
检索特定LLD规则ID的所有监控项原型。
请求：
{"jsonrpc": "2.0","method": "itemprototype.get","params": {"output": "extend","discoveryids": "27426"},"id": 1}
响应：
{"jsonrpc": "2.0","result": [{"itemid": "23077","type": "0","snmp_oid": "","hostid": "10079","name": "Incoming network traffic on en0","key_": "net.if.in[en0]","delay": "1m","history": "1w","trends": "365d","status": "0","value_type": "3","trapper_hosts": "","units": "bps","logtimefmt": "","templateid": "0","valuemapid": "0","params": "","ipmi_sensor": "","authtype": "0","username": "","password": "","publickey": "","privatekey": "","interfaceid": "0","description": "","evaltype": "0","jmx_endpoint": "","master_itemid": "0","timeout": "","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","discover": "0","uuid": "","parameters": []},{"itemid": "10010","type": "0","snmp_oid": "","hostid": "10001","name": "Processor load (1 min average per core)","key_": "system.cpu.load[percpu,avg1]","delay": "1m","history": "1w","trends": "365d","status": "0","value_type": "0","trapper_hosts": "","units": "","logtimefmt": "","templateid": "0","valuemapid": "0","params": "","ipmi_sensor": "","authtype": "0","username": "","password": "","publickey": "","privatekey": "","interfaceid": "0","description": "The processor load is calculated as system CPU load divided by number of CPU cores.","evaltype": "0","jmx_endpoint": "","master_itemid": "0","timeout": "","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","discover": "0","uuid": "","parameters": []}],"id": 1}
查找依赖监控项
为特定监控项ID查找一个依赖监控项。
请求：
{"jsonrpc": "2.0","method": "item.get","params": {"output": "extend","filter": {"type": 18,"master_itemid": "25545"},"limit": "1"},"id": 1}
响应：
{"jsonrpc": "2.0","result": [{"itemid": "25547","type": "18","snmp_oid": "","hostid": "10116","name": "Seconds","key_": "apache.status.uptime.seconds","delay": "0","history": "90d","trends": "365d","status": "0","value_type": "3","trapper_hosts": "","units": "","logtimefmt": "","templateid": "0","valuemapid": "0","params": "","ipmi_sensor": "","authtype": "0","username": "","password": "","publickey": "","privatekey": "","interfaceid": "0","description": "","evaltype": "0","master_itemid": "25545","jmx_endpoint": "","timeout": "","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","discover": "0","uuid": "","parameters": []}],"id": 1}
查找HTTP代理监控项原型
通过指定主机id的请求头部方法查找HTTP代理监控项原型。
请求：
{"jsonrpc": "2.0","method": "itemprototype.get","params": {"hostids": "10254","filter": {"type": 19,"request_method": 3}},"id": 1}
响应：
{"jsonrpc": "2.0","result": [{"itemid": "28257","type": "19","snmp_oid": "","hostid": "10254","name": "discovered","key_": "item[{#INAME}]","delay": "{#IUPDATE}","history": "90d","trends": "30d","status": "0","value_type": "3","trapper_hosts": "","units": "","logtimefmt": "","templateid": "28255","valuemapid": "0","params": "","ipmi_sensor": "","authtype": "0","username": "","password": "","publickey": "","privatekey": "","flags": "2","interfaceid": "2","description": "","evaltype": "0","jmx_endpoint": "","master_itemid": "0","timeout": "","url": "{#IURL}","query_fields": [],"posts": "","status_codes": "","follow_redirects": "0","post_type": "0","http_proxy": "","headers": [],"retrieve_mode": "0","request_method": "3","output_format": "0","ssl_cert_file": "","ssl_key_file": "","ssl_key_password": "","verify_peer": "0","verify_host": "0","allow_traps": "0","discover": "0","uuid": "","parameters": []}],"id": 1}
参阅
来源
CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.
