[comment]: # ({ddce888e-ddce888e}) # discoveryrule.get [comment]: # ({/ddce888e-ddce888e}) [comment]: # ({e9f79f9b-b87cd1ee}) ### Описание `integer/array discoveryrule.get(параметры объектов)` Этот метод позволяет получать правила LLD в соответствии с заданными параметрами. ::: noteclassic Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/e9f79f9b-b87cd1ee}) [comment]: # ({ae0c9661-57007d3d}) ### Параметры `(object)` Параметры, определяющие требуемый результат. Метод поддерживает следующие параметры. |Parameter|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |itemids|ID/array|Возвращать только правила LLD с указанными ID.| |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, которые принадлежат указанным шаблонам.| |selectDiscoveryData|query|Возвращать свойство `discoveryData` с данными объекта обнаружения правила LLD. Объект обнаружения правила LLD связывает обнаруженное правило LLD с прототипом правила LLD, из которого оно было обнаружено.| |selectDiscoveryRulePrototypes|query|Возвращать свойство [`discoveryRulePrototypes`](/manual/api/reference/discoveryruleprototype/object) с прототипами правил LLD, которые принадлежат правилу LLD.

Поддерживает `count`.| |selectFilter|query|Возвращать свойство [`filter`](/manual/api/reference/discoveryrule/object#lld-rule-filter) с данными фильтра, используемого правилом LLD.| |selectGraphs|query|Возвращает свойство [`graphs`](/manual/api/reference/graph/object) с прототипами графиков, которые принадлежат правилу LLD.

Поддерживает `count`.| |selectHostPrototypes|query|Возвращать свойство [`hostPrototypes`](/manual/api/reference/hostprototype/object) с прототипами узлов сети, которые принадлежат правилу LLD.

Поддерживает `count`.| |selectHosts|query|Возвращать свойство [`hosts`](/manual/api/reference/host/object) с массивом узлов сети, к которым принадлежит правило LLD.| |selectItems|query|Возвращать свойство [`items`](/manual/api/reference/item/object) с прототипами элементов данных, которые принадлежат правилу LLD.

Поддерживает `count`.| |selectTriggers|query|Возвращать свойство [`triggers`](/manual/api/reference/trigger/object) с прототипами триггеров, которые принадлежат правилу LLD.

Поддерживает `count`.| |selectLLDMacroPaths|query|Возвращать свойство [`lld_macro_paths`](/manual/api/reference/discoveryrule/object#lld-macro-path) со списком макросов LLD и путей к значениям, назначенным каждому соответствующему макросу.| |selectPreprocessing|query|Возвращать свойство [`preprocessing`](/manual/api/reference/discoveryrule/object#lld-rule-preprocessing) с параметрами предварительной обработки правила LLD.| |selectOverrides|query|Возвращать свойство [`lld_rule_overrides`](/manual/api/reference/discoveryrule/object#lld-rule-overrides) со списком фильтров переопределения, условий и операций, выполняемых над объектами прототипов.| |filter|object|Возвращать только те результаты, которые точно соответствуют заданному фильтру.

Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений для сопоставления.

Не поддерживает свойства с [типом данных](/manual/api/reference_commentary#data-types) `text`.

Поддерживает дополнительные свойства:
`host` - техническое имя узла сети, к которому принадлежит правило LLD.| |limitSelects|integer|Ограничивает количество записей, возвращаемых подвыборками.

Применяется к следующим подвыборкам: `selectItems`, `selectGraphs`, `selectTriggers`.| |sortfield|string/array|Сортировать результат по указанным свойствам.

Возможные значения: `itemid`, `name`, `key_`, `delay`, `type`, `status`.| |countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/ae0c9661-57007d3d}) [comment]: # ({7223bab1-7223bab1}) ### Возвращаемые значения `(целое число/массив)` Возвращает либо: - · массив объектов; - · количество извлеченных объектов, если использовался параметр `countOutput`. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Примеры [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({ab9d9991-5f8b5429}) #### Получение правил обнаружения с узла сети Получить все правила обнаружения для указанного ID узла сети. [Запрос](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": "extend", "hostids": "10202" }, "id": 1 } ``` Ответ: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "27425", "type": "0", "snmp_oid": "", "hostid": "10202", "name": "Обнаружение сетевого интерфейса", "key_": "net.if.discovery", "delay": "1h", "status": "0", "trapper_hosts": "", "templateid": "22444", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "1", "interfaceid": "119", "description": "Обнаружение сетевых интерфейсов, как определено в глобальном регулярном выражении \"Network interfaces for discovery\".", "lifetime": "30d", "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", "uuid": "", "lifetime_type": "0", "enabled_lifetime_type": "2", "enabled_lifetime": "0", "state": "0", "error": "", "parameters": [] }, { "itemid": "27426", "type": "0", "snmp_oid": "", "hostid": "10202", "name": "Обнаружение смонтированных файловых систем", "key_": "vfs.fs.discovery", "delay": "1h", "status": "0", "trapper_hosts": "", "templateid": "22450", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "1", "interfaceid": "119", "description": "Обнаружение файловых систем разных типов, как определено в глобальном регулярном выражении \"File systems for discovery\".", "lifetime": "30d", "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", "uuid": "", "lifetime_type": "0", "enabled_lifetime_type": "2", "enabled_lifetime": "0", "state": "0", "error": "", "parameters": [] } ], "id": 1 } ``` [comment]: # ({/ab9d9991-5f8b5429}) [comment]: # ({22ef0184-4d0af030}) #### Получение условий фильтра Получите имя правила LLD "24681" и его условия фильтра. Фильтр использует тип оценки "and", поэтому свойство `formula` пустое, а `eval_formula` генерируется автоматически. [Запрос](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "selectFilter": "extend", "itemids": ["24681"] }, "id": 1 } ``` Ответ: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "24681", "name": "Filtered LLD rule", "filter": { "evaltype": "1", "formula": "", "conditions": [ { "macro": "{#MACRO1}", "value": "@regex1", "operator": "8", "formulaid": "A" }, { "macro": "{#MACRO2}", "value": "@regex2", "operator": "9", "formulaid": "B" }, { "macro": "{#MACRO3}", "value": "", "operator": "12", "formulaid": "C" }, { "macro": "{#MACRO4}", "value": "", "operator": "13", "formulaid": "D" } ], "eval_formula": "A and B and C and D" } } ], "id": 1 } ``` [comment]: # ({/22ef0184-4d0af030}) [comment]: # ({6830cd5d-e3de6fe8}) #### Получение правила LLD по URL Получение правила LLD для узла сети по значению поля URL правила. Поддерживается только точное совпадение строки URL, определенной для правила LLD. [Запрос](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "hostids": "10257", "filter": { "type": 19, "url": "http://127.0.0.1/discoverer.php" } }, "id": 1 } ``` Ответ: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "28336", "type": "19", "snmp_oid": "", "hostid": "10257", "name": "API HTTP agent", "key_": "api_discovery_rule", "delay": "5s", "status": "0", "trapper_hosts": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "1", "interfaceid": "5", "description": "", "lifetime": "30d", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "http://127.0.0.1/discoverer.php", "query_fields": [ { "name": "mode", "value": "json" }, { "name": "elements", "value": "2" } ], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [ { "name" : "X-Type", "value": "api" }, { "name": "Authorization", "value": "Bearer mF_A.B5f-2.1JcM" } ], "retrieve_mode": "0", "request_method": "1", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "lifetime_type": "0", "enabled_lifetime_type": "2", "enabled_lifetime": "0", "state": "0", "error": "", "parameters": [] } ], "id": 1 } ``` [comment]: # ({/6830cd5d-e3de6fe8}) [comment]: # ({cbbe028e-c0ae2d21}) #### Получение правила LLD с переопределениями Получение одного правила LLD с различными настройками переопределений. [Запрос](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "itemids": "30980", "selectOverrides": ["name", "step", "stop", "filter", "operations"] }, "id": 1 } ``` Ответ: ```json { "jsonrpc": "2.0", "result": [ { "name": "Discover database host", "overrides": [ { "name": "Discover MySQL host", "step": "1", "stop": "1", "filter": { "evaltype": "2", "formula": "", "conditions": [ { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^mysqld\\.service$", "formulaid": "A" }, { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^mariadb\\.service$", "formulaid": "B" } ], "eval_formula": "A or B" }, "operations": [ { "operationobject": "3", "operator": "2", "value": "Database host", "opstatus": { "status": "0" }, "optag": [ { "tag": "database", "value": "mysql" } ], "optemplate": [ { "templateid": "10170" } ] } ] }, { "name": "Discover PostgreSQL host", "step": "2", "stop": "1", "filter": { "evaltype": "0", "formula": "", "conditions": [ { "macro": "{#UNIT.NAME}", "operator": "8", "value": "^postgresql\\.service$", "formulaid": "A" } ], "eval_formula": "A" }, "operations": [ { "operationobject": "3", "operator": "2", "value": "Database host", "opstatus": { "status": "0" }, "optag": [ { "tag": "database", "value": "postgresql" } ], "optemplate": [ { "templateid": "10263" } ] } ] } ] } ], "id": 1 } ``` [comment]: # ({/cbbe028e-c0ae2d21}) [comment]: # ({590f198c-f25d02bb}) ### См. также - [Прототип графика](/manual/api/reference/graphprototype/object#graph-prototype) - [Узел сети](/manual/api/reference/host/object#host) - [Прототип элемента данных](/manual/api/reference/itemprototype/object#item-prototype) - [Фильтр правила LLD](object#lld-rule-filter) - [Прототип триггера](/manual/api/reference/triggerprototype/object#trigger-prototype) [comment]: # ({/590f198c-f25d02bb}) [comment]: # ({e14efed8-e14efed8}) ### Источник CDiscoveryRule::get() в *ui/include/classes/api/services/CDiscoveryRule.php*. [comment]: # ({/e14efed8-e14efed8})