integer/array drule.get(object parameters)
该方法允许根据给定参数检索发现规则。
此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles。
(object)
定义输出结果的参数。
该方法支持以下参数。
参数 | 数据类型 | 描述 |
---|---|---|
dhostids | string/array | 仅返回创建了指定被发现主机的发现规则。 |
druleids | string/array | 仅返回具有指定ID的发现规则。 |
dserviceids | string/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)
返回以下两种结果之一:
countOutput
参数,则返回检索到的objects数量。获取所有已配置的发现规则及其使用的发现检查项。
请求:
{
"jsonrpc": "2.0",
"method": "drule.get",
"params": {
"output": "extend",
"selectDChecks": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
响应:
{
"jsonrpc": "2.0",
"result": [
{
"druleid": "2",
"proxy_hostid": "0",
"name": "Local network",
"iprange": "192.168.3.1-255",
"delay": "5s",
"nextcheck": "1348754327",
"status": "0",
"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",
"host_source": "1",
"name_source": "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",
"host_source": "1",
"name_source": "0"
}
]
},
{
"druleid": "6",
"proxy_hostid": "0",
"name": "Zabbix agent discovery",
"iprange": "192.168.1.1-255",
"delay": "1h",
"nextcheck": "0",
"status": "0",
"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",
"host_source": "2",
"name_source": "3"
}
]
}
],
"id": 1
}
CDRule::get() 位于 ui/include/classes/api/services/CDRule.php 文件中。