获取

描述

integer/array drule.get(object parameters)

此方法允许根据给定参数检索发现规则。

此方法对任何类型的用户可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请查看用户角色。

参数

(object) 定义需要输出的参数。

此方法支持以下参数。

参数类型描述
dhostidsstring/array仅返回创建给定已发现主机的发现规则。
druleidsstring/array仅返回具有给定 ID 的发现规则。
dserviceidsstring/array仅返回创建给定已发现服务的发现规则。
selectDChecksquery返回 dchecks 属性，其中包含发现规则使用的发现检查。

支持 count。
selectDHostsquery返回 dhosts 属性，其中包含由发现规则创建的已发现主机。

Supports count.
limitSelectsinteger限制子选择返回的记录数。

适用于以下子选择：
selectDChecks - 结果将按照 dcheckid 排序；
selectDHosts - 结果将按照 dhostsid 排序。
sortfieldstring/array根据给定的属性对结果进行排序。

可用值：druleid 和 name。
countOutputboolean这些参数对于所有的 get 方法都是通用的，详细描述请参见 参考说明。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回其中一种结果：

  • 一个对象数组；
  • 如果使用了参数countOutput，则返回检索到的对象的数量。

示例

检索所有发现规则

检索所有配置的发现规则及其使用的发现检查。

请求：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "drule.get",
  4.            "params": {
  5.                "output": "extend",
  6.                "selectDChecks": "extend"
  7.            },
  8.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.            "id": 1
  10.        }

响应：

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "druleid": "2",
  6.                    "proxy_hostid": "0",
  7.                    "name": "Local network",
  8.                    "iprange": "192.168.3.1-255",
  9.                    "delay": "5s",
  10.                    "nextcheck": "1348754327",
  11.                    "status": "0",
  12.                    "dchecks": [
  13.                        {
  14.                            "dcheckid": "7",
  15.                            "druleid": "2",
  16.                            "type": "3",
  17.                            "key_": "",
  18.                            "snmp_community": "",
  19.                            "ports": "21",
  20.                            "snmpv3_securityname": "",
  21.                            "snmpv3_securitylevel": "0",
  22.                            "snmpv3_authpassphrase": "",
  23.                            "snmpv3_privpassphrase": "",
  24.                            "uniq": "0",
  25.                            "snmpv3_authprotocol": "0",
  26.                            "snmpv3_privprotocol": "0",
  27.                            "host_source": "1",
  28.                            "name_source": "0"                     
  29.                        },
  30.                        {
  31.                            "dcheckid": "8",
  32.                            "druleid": "2",
  33.                            "type": "4",
  34.                            "key_": "",
  35.                            "snmp_community": "",
  36.                            "ports": "80",
  37.                            "snmpv3_securityname": "",
  38.                            "snmpv3_securitylevel": "0",
  39.                            "snmpv3_authpassphrase": "",
  40.                            "snmpv3_privpassphrase": "",
  41.                            "uniq": "0",
  42.                            "snmpv3_authprotocol": "0",
  43.                            "snmpv3_privprotocol": "0",
  44.                            "host_source": "1",
  45.                            "name_source": "0"                    
  46.                        }
  47.                    ]
  48.                },
  49.                {
  50.                    "druleid": "6",
  51.                    "proxy_hostid": "0",
  52.                    "name": "Zabbix agent discovery",
  53.                    "iprange": "192.168.1.1-255",
  54.                    "delay": "1h",
  55.                    "nextcheck": "0",
  56.                    "status": "0",
  57.                    "dchecks": [
  58.                        {
  59.                            "dcheckid": "10",
  60.                            "druleid": "6",
  61.                            "type": "9",
  62.                            "key_": "system.uname",
  63.                            "snmp_community": "",
  64.                            "ports": "10050",
  65.                            "snmpv3_securityname": "",
  66.                            "snmpv3_securitylevel": "0",
  67.                            "snmpv3_authpassphrase": "",
  68.                            "snmpv3_privpassphrase": "",
  69.                            "uniq": "0",
  70.                            "snmpv3_authprotocol": "0",
  71.                            "snmpv3_privprotocol": "0",
  72.                            "host_source": "2",
  73.                            "name_source": "3"                    
  74.                        }
  75.                    ]
  76.                }
  77.            ],
  78.            "id": 1
  79.        }

参见

来源

ui/include/classes/api/services/CDRule.php 中的 CDRule::get()。