[comment]: # ({ddce888e-ddce888e}) # discoveryrule.get [comment]: # ({/ddce888e-ddce888e}) [comment]: # ({e9f79f9b-b87cd1ee}) ### Opis `integer/array discoveryrule.get(object parameters)` Metoda umożliwia pobieranie reguł LLD zgodnie z podanymi parametrami. ::: noteclassic Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji [Role użytkowników](/manual/web_interface/frontend_sections/users/user_roles). ::: [comment]: # ({/e9f79f9b-b87cd1ee}) [comment]: # ({ae0c9661-57007d3d}) ### Parametry `(object)` Parametry definiujące żądane dane wyjściowe. Metoda obsługuje następujące parametry. |Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis| |--|--|------| |itemids|ID/array|Zwraca tylko reguły LLD o podanych identyfikatorach.| |groupids|ID/array|Zwraca tylko reguły LLD należące do hostów z podanych grup.| |hostids|ID/array|Zwraca tylko reguły LLD należące do podanych hostów.| |inherited|boolean|Jeśli ustawiono `true`, zwraca tylko reguły LLD odziedziczone z szablonu.| |interfaceids|ID/array|Zwraca tylko reguły LLD używające podanych interfejsów hosta.| |monitored|boolean|Jeśli ustawiono `true`, zwraca tylko włączone reguły LLD należące do monitorowanych hostów.| |templated|boolean|Jeśli ustawiono `true`, zwraca tylko reguły LLD należące do szablonów.| |templateids|ID/array|Zwraca tylko reguły LLD należące do podanych szablonów.| |selectDiscoveryData|query|Zwraca właściwość `discoveryData` z danymi obiektu wykrywania reguły LLD. Obiekt wykrywania reguły LLD łączy wykrytą regułę LLD z prototypem reguły LLD, z którego została wykryta.| |selectDiscoveryRulePrototypes|query|Zwraca właściwość [`discoveryRulePrototypes`](/manual/api/reference/discoveryruleprototype/object) z prototypami reguł LLD należącymi do reguły LLD.

Obsługuje `count`.| |selectFilter|query|Zwraca właściwość [`filter`](/manual/api/reference/discoveryrule/object#lld-rule-filter) z danymi filtra używanego przez regułę LLD.| |selectGraphs|query|Zwraca właściwość [`graphs`](/manual/api/reference/graph/object) z prototypami wykresów należącymi do reguły LLD.

Obsługuje `count`.| |selectHostPrototypes|query|Zwraca właściwość [`hostPrototypes`](/manual/api/reference/hostprototype/object) z prototypami hostów należącymi do reguły LLD.

Obsługuje `count`.| |selectHosts|query|Zwraca właściwość [`hosts`](/manual/api/reference/host/object) z tablicą hostów, do których należy reguła LLD.| |selectItems|query|Zwraca właściwość [`items`](/manual/api/reference/item/object) z prototypami pozycji należącymi do reguły LLD.

Obsługuje `count`.| |selectTriggers|query|Zwraca właściwość [`triggers`](/manual/api/reference/trigger/object) z prototypami wyzwalaczy należącymi do reguły LLD.

Obsługuje `count`.| |selectLLDMacroPaths|query|Zwraca właściwość [`lld_macro_paths`](/manual/api/reference/discoveryrule/object#lld-macro-path) z listą makr LLD i ścieżek do wartości przypisanych do każdego odpowiadającego makra.| |selectPreprocessing|query|Zwraca właściwość [`preprocessing`](/manual/api/reference/discoveryrule/object#lld-rule-preprocessing) z opcjami przetwarzania wstępnego reguły LLD.| |selectOverrides|query|Zwraca właściwość [`lld_rule_overrides`](/manual/api/reference/discoveryrule/object#lld-rule-overrides) z listą filtrów nadpisywania, warunków i operacji wykonywanych na obiektach prototypów.| |filter|object|Zwraca tylko te wyniki, które dokładnie odpowiadają podanemu filtrowi.

Akceptuje obiekt, w którym kluczami są nazwy właściwości, a wartościami są pojedyncza wartość lub tablica wartości do dopasowania.

Nie obsługuje właściwości typu danych `text` [data type](/manual/api/reference_commentary#data-types).

Obsługuje dodatkowe właściwości:
`host` - nazwa techniczna hosta, do którego należy reguła LLD.| |limitSelects|integer|Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań: `selectItems`, `selectGraphs`, `selectTriggers`.| |sortfield|string/array|Sortuje wynik według podanych właściwości.

Możliwe wartości: `itemid`, `name`, `key_`, `delay`, `type`, `status`.| |countOutput|boolean|Te parametry opisano w [komentarzu referencyjnym](/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}) ### Zwracane wartości `(integer/array)` Zwraca: - tablicę obiektów; - liczbę pobranych obiektów, jeśli użyto parametru `countOutput`. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Przykłady [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({ab9d9991-5f8b5429}) #### Pobieranie reguł wykrywania z hosta Pobierz wszystkie reguły wykrywania dla określonego ID hosta. [Żądanie](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": "extend", "hostids": "10202" }, "id": 1 } ``` Odpowiedź: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "27425", "type": "0", "snmp_oid": "", "hostid": "10202", "name": "Network interface discovery", "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": "Discovery of network interfaces as defined in global regular expression \"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": "Mounted filesystem discovery", "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": "Discovery of file systems of different types as defined in global regular expression \"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}) #### Pobieranie warunków filtra Pobierz nazwę reguły LLD "24681" oraz jej warunki filtra. Filtr używa typu oceny "and", więc właściwość `formula` jest pusta, a `eval_formula` jest generowana automatycznie. [Żądanie](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "selectFilter": "extend", "itemids": ["24681"] }, "id": 1 } ``` Odpowiedź: ```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}) #### Pobierz regułę LLD według URL Pobiera regułę LLD dla hosta na podstawie wartości pola URL reguły. Obsługiwane jest tylko dokładne dopasowanie ciągu URL zdefiniowanego dla reguły LLD. [Żądanie](/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 } ``` Odpowiedź: ```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}) #### Pobieranie reguły LLD z nadpisaniami Pobierz jedną regułę LLD, która ma różne ustawienia nadpisywania. [Żądanie](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "itemids": "30980", "selectOverrides": ["name", "step", "stop", "filter", "operations"] }, "id": 1 } ``` Odpowiedź: ```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}) ### Zobacz także - [Prototyp wykresu](/manual/api/reference/graphprototype/object#graph-prototype) - [Host](/manual/api/reference/host/object#host) - [Prototyp pozycji](/manual/api/reference/itemprototype/object#item-prototype) - [Filtr reguły LLD](object#lld-rule-filter) - [Prototyp wyzwalacza](/manual/api/reference/triggerprototype/object#trigger-prototype) [comment]: # ({/590f198c-f25d02bb}) [comment]: # ({e14efed8-e14efed8}) ### Źródło CDiscoveryRule::get() w *ui/include/classes/api/services/CDiscoveryRule.php*. [comment]: # ({/e14efed8-e14efed8})