On this page
discoveryruleprototype.get
描述
integer/array discoveryruleprototype.get(object parameters)
该方法允许根据给定参数检索 LLD 规则原型。
此方法对任何类型的用户都可用。
调用该方法的权限可在用户角色设置中撤销。
更多信息请参见 用户角色。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| discoveryids | ID/array | 仅返回属于给定 LLD 规则或 LLD 规则原型的 LLD 规则原型。 |
| itemids | ID/array | 仅返回具有给定 ID 的 LLD 规则原型。 |
| groupids | ID/array | 仅返回属于给定组中主机的 LLD 规则原型。 |
| hostids | ID/array | 仅返回属于给定主机的 LLD 规则原型。 |
| inherited | boolean | 如果设置为 true，则仅返回从模板继承的 LLD 规则原型。 |
| interfaceids | ID/array | 仅返回使用给定主机接口的 LLD 规则原型。 |
| monitored | boolean | 如果设置为 true，则仅返回属于受监控主机的已启用 LLD 规则原型。 |
| templated | boolean | 如果设置为 true，则仅返回属于模板的 LLD 规则原型。 |
| templateids | ID/array | 仅返回属于给定模板的 LLD 规则原型。 |
| selectDiscoveryRule | query | 返回 discoveryRule 属性，其中包含该 LLD 规则原型的父 LLD 规则。如果父级是发现规则原型，则将返回空响应。 |
| selectDiscoveryRulePrototype | query | 返回 discoveryRulePrototype 属性，其中包含该 LLD 规则原型的父 LLD 规则原型。如果父级是发现规则（非原型），则将返回空响应。 |
| selectDiscoveryRulePrototypes | query | 返回 discoveryRulePrototypes 属性，其中包含属于该 LLD 规则原型的子 LLD 规则原型。支持 count。 |
| selectFilter | query | 返回 filter 属性，其中包含该 LLD 规则原型所使用过滤器的数据。 |
| selectGraphs | query | 返回 graphs 属性，其中包含属于该 LLD 规则原型的图形原型。支持 count。 |
| selectHostPrototypes | query | 返回 hostPrototypes 属性，其中包含属于该 LLD 规则原型的主机原型。支持 count。 |
| selectHosts | query | 返回 hosts 属性，其中包含该 LLD 规则原型所属主机的数组。 |
| selectItems | query | 返回 items 属性，其中包含属于该 LLD 规则原型的监控项原型。支持 count。 |
| selectTriggers | query | 返回 triggers 属性，其中包含属于该 LLD 规则原型的触发器原型。支持 count。 |
| selectLLDMacroPaths | query | 返回 lld_macro_paths 属性，其中包含 LLD 宏列表以及分配给每个对应宏的值路径。 |
| selectPreprocessing | query | 返回 preprocessing 属性，其中包含 LLD 规则原型的预处理选项。 |
| selectOverrides | query | 返回 lld_rule_overrides 属性，其中包含对原型对象执行的覆盖过滤器、条件和操作列表。 |
| filter | object | 仅返回与给定过滤器完全匹配的结果。 接受一个对象，其中键为属性名称，值可以是单个值，也可以是用于匹配的值数组。 不支持 text 数据类型 的属性。支持附加属性： host - 该 LLD 规则原型所属主机的技术名称。 |
| limitSelects | integer | 限制子选择返回的记录数。 适用于以下子选择： selectItems、selectGraphs、selectTriggers。 |
| sortfield | string/array | 按给定属性对结果进行排序。 可能的值： itemid、name、key_、delay、type、status。 |
| countOutput | boolean | 这些参数在参考说明中进行了描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下之一：
- 对象数组；
- 如果使用了
countOutput参数，则返回已检索对象的数量。
示例
从主机检索发现规则原型
检索指定主机 ID 的所有发现规则原型。
请求：
{
"jsonrpc": "2.0",
"method": "discoveryruleprototype.get",
"params": {
"hostids": "10084"
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "47253",
"type": "23",
"snmp_oid": "",
"hostid": "10084",
"name": "发现 {#DB} 的表空间",
"key_": "db.tablespace.discovery[{#DB}]",
"delay": "0",
"history": "31d",
"trends": "365d",
"status": "0",
"value_type": "4",
"trapper_hosts": "",
"units": "",
"logtimefmt": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"flags": "3",
"interfaceid": "0",
"description": "",
"inventory_link": "0",
"lifetime": "7d",
"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": "",
"lifetime_type": "0",
"enabled_lifetime_type": "2",
"enabled_lifetime": "0",
"parameters": []
}
],
"id": 1
}另请参阅
源代码
位于 ui/include/classes/api/services/CDiscoveryRulePrototype.php 中的 CDiscoveryRulePrototype::get()。