发现规则原型.get

描述

integer/array discoveryruleprototype.get(object parameters)

该方法允许根据给定参数检索LLD规则原型。

该方法对所有类型的用户可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles

参数

(object) 定义期望输出的参数.

该方法支持以下参数.

参数 数据类型 描述
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 返回包含LLD规则原型的父LLD规则的discoveryRule属性.
selectDiscoveryRulePrototype query 返回包含LLD规则原型的父LLD规则原型的discoveryRulePrototype属性.
selectDiscoveryRulePrototypes query 返回包含属于该LLD规则原型的子LLD规则原型的discoveryRulePrototypes属性.

支持count.
selectFilter query 返回包含LLD规则原型使用的过滤器数据的filter属性.
selectGraphs query 返回包含属于LLD规则原型的图形原型的graphs属性.

支持count.
selectHostPrototypes query 返回包含属于LLD规则原型的主机原型的hostPrototypes属性.

支持count.
selectHosts query 返回包含LLD规则原型所属主机array的hosts属性.
selectItems query 返回包含属于LLD规则原型的监控项原型的items属性.

支持count.
selectTriggers query 返回包含属于LLD规则原型的触发器原型的triggers属性.

支持count.
selectLLDMacroPaths query 返回包含LLD宏列表及每个宏对应值路径的lld_macro_paths属性.
selectPreprocessing query 返回包含LLD规则原型预处理选项的preprocessing属性.
selectOverrides query 返回包含对原型objects执行的覆盖过滤器、条件和操作列表的lld_rule_overrides属性.
filter object 仅返回完全匹配给定过滤器的结果.

接受object,其中键为属性名,值为单个值或用于匹配的array.

不支持text数据类型属性.

支持附加属性:
host - LLD规则原型所属主机的技术名称.
limitSelects integer 限制子查询返回的记录数.

适用于以下子查询: selectItems, selectGraphs, selectTriggers.
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) 返回以下两种结果之一:

  • 一个包含objects的array;
  • 检索到的objects数量, 如果使用了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": "Discover tablespaces for {#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",
                   "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
       }

另请参阅

来源

CDiscoveryRulePrototype::get() 位于 ui/include/classes/api/services/CDiscoveryRulePrototype.php 文件中.