[comment]: # ({dbbaf81a-dbbaf81a})
# drule.get

[comment]: # ({/dbbaf81a-dbbaf81a})

[comment]: # ({6a314bbc-bbd48f20})
### Описание

`integer/array drule.get(параметры объектов)`

Этот метод позволяет получать правила обнаружения в соответствии с
заданными параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/6a314bbc-bbd48f20})

[comment]: # ({f716a122-0b971cc5})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dhostids|ID/array|Возвращать только правила обнаружения, которые создали указанные обнаруженные узлы сети.|
|druleids|ID/array|Возвращать только правила обнаружения с указанными ID.|
|dserviceids|ID/array|Возвращать только правила обнаружения, которые создали указанные обнаруженные сервисы.|
|selectDChecks|query|Возвращать свойство [`dchecks`](/manual/api/reference/dcheck/object) с проверками обнаружения, используемыми правилом обнаружения.<br><br>Поддерживает `count`.|
|selectDHosts|query|Возвращать свойство [`dhosts`](/manual/api/reference/dhost/object) с обнаруженными узлами сети, созданными правилом обнаружения.<br><br>Поддерживает `count`.|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подзапросами.<br><br>Применяется к следующим подзапросам:<br>`selectDChecks` - результаты будут отсортированы по `dcheckid`;<br>`selectDHosts` - результаты будут отсортированы по `dhostsid`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `druleid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/f716a122-0b971cc5})

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({3de6f53e-153ca11b})
#### Получить все правила обнаружения

Получить все настроенные правила обнаружения и проверки обнаружения, которые они используют.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "drule.get",
    "params": {
        "output": "extend",
        "selectDChecks": "extend"
    },
    "id": 1
}
```

Ответ:

```json
{
    "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
}
```

[comment]: # ({/3de6f53e-153ca11b})

[comment]: # ({be4cea66-f2f964c1})
### См. также

-   [Обнаруженный
    узел сети](/manual/api/reference/dhost/object#discovered-host)
-   [Проверка
    обнаружения](/manual/api/reference/dcheck/object#discovery-check)

[comment]: # ({/be4cea66-f2f964c1})

[comment]: # ({365d15ae-365d15ae})
### Источник

CDRule::get() в *ui/include/classes/api/services/CDRule.php*.

[comment]: # ({/365d15ae-365d15ae})