Documentation
drule.get
描述
integer/array drule.get(object parameters)
该方法允许根据给定的参数检索发现规则。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见 User roles。
参数
(object) 用于定义期望输出的参数。
该方法支持以下参数。
| 参数 | 数据类型 类型 | 描述 |
|---|---|---|
| dhostids | ID/array | 仅返回创建了给定已发现 主机 的发现规则。 |
| druleids | ID/array | 仅返回具有给定ID的发现规则。 |
| dserviceids | ID/array | 仅返回创建了给定已发现服务的发现规则。 |
| selectDChecks | query | 返回一个包含发现规则所使用的发现检查的 dchecks 属性。支持 count。 |
| selectDHosts | query | 返回一个包含发现规则创建的已发现 主机 的 dhosts 属性。支持 count。 |
| limitSelects | integer | 限制子查询返回的记录数量。 适用于以下子查询： selectDChecks - 结果将按 dcheckid 排序；selectDHosts - 结果将按 dhostsid 排序。 |
| sortfield | string/array | 按照给定属性对结果进行排序。 可能的值： druleid、name。 |
| countOutput | boolean | 这些参数在 通用get方法参数 中有描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下之一：
- array 的 objects；
- 如果使用了
countOutput参数，则为检索到的 objects 的数量。
示例
获取所有发现规则
检索所有配置的发现规则及其使用的发现检查。
执行请求:
{
"jsonrpc": "2.0",
"method": "drule.get",
"params": {
"output": "extend",
"selectDChecks": "extend"
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": [
{
"druleid": "2",
"proxyid": "0",
"name": "Local network",
"iprange": "192.168.3.1-255",
"delay": "5s",
"status": "0",
"concurrency_max": "0",
"error": "",
"dchecks": [
{
"dcheckid": "7",
"druleid": "2",
"type": "3",
"key_": "",
"snmp_community": "",
"ports": "21",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"snmpv3_contextname": "",
"host_source": "1",
"name_source": "0",
"allow_redirect": "0"
},
{
"dcheckid": "8",
"druleid": "2",
"type": "4",
"key_": "",
"snmp_community": "",
"ports": "80",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"snmpv3_contextname": "",
"host_source": "1",
"name_source": "0",
"allow_redirect": "0"
}
]
},
{
"druleid": "6",
"proxyid": "0",
"name": "Zabbix agent discovery",
"iprange": "192.168.1.1-255",
"delay": "1h",
"status": "0",
"concurrency_max": "10",
"error": "",
"dchecks": [
{
"dcheckid": "10",
"druleid": "6",
"type": "9",
"key_": "system.uname",
"snmp_community": "",
"ports": "10050",
"snmpv3_securityname": "",
"snmpv3_securitylevel": "0",
"snmpv3_authpassphrase": "",
"snmpv3_privpassphrase": "",
"uniq": "0",
"snmpv3_authprotocol": "0",
"snmpv3_privprotocol": "0",
"snmpv3_contextname": "",
"host_source": "2",
"name_source": "3",
"allow_redirect": "0"
}
]
}
],
"id": 1
}另请参阅
来源
CDRule::get() 在 ui/include/classes/api/services/CDRule.php 中。