[comment]: # ({ddce888e-ddce888e}) # discoveryrule.get [comment]: # ({/ddce888e-ddce888e}) [comment]: # ({e9f79f9b-b87cd1ee}) ### Descrição `integer/array discoveryrule.get(object parameters)` O método permite recuperar regras de LLD de acordo com os parâmetros informados. ::: noteclassic Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para obter mais informações. ::: [comment]: # ({/e9f79f9b-b87cd1ee}) [comment]: # ({83f48154-57007d3d}) ### Parâmetros `(object)` Parâmetros que definem a saída desejada. O método suporta os seguintes parâmetros. |Parameter|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |itemids|ID/array|Retorna apenas regras de LLD com os IDs informados.| |groupids|ID/array|Retorna apenas regras de LLD que pertencem aos hosts dos grupos informados.| |hostids|ID/array|Retorna apenas regras de LLD que pertencem aos hosts informados.| |inherited|boolean|Se definido como `true`, retorna apenas regras de LLD herdadas de um template.| |interfaceids|ID/array|Retorna apenas regras de LLD que usam as interfaces de host informadas.| |monitored|boolean|Se definido como `true`, retorna apenas regras de LLD habilitadas que pertencem a hosts monitorados.| |templated|boolean|Se definido como `true`, retorna apenas regras de LLD que pertencem a templates.| |templateids|ID/array|Retorna apenas regras de LLD que pertencem aos templates informados.| |selectFilter|query|Retorna uma propriedade [`filter`](/manual/api/reference/discoveryrule/object#lld-rule-filter) com os dados do filtro usado pela regra de LLD.| |selectGraphs|query|Retorna uma propriedade [`graphs`](/manual/api/reference/graph/object) com protótipos de gráfico que pertencem à regra de LLD.

Suporta `count`.| |selectHostPrototypes|query|Retorna uma propriedade [`hostPrototypes`](/manual/api/reference/hostprototype/object) com protótipos de host que pertencem à regra de LLD.

Suporta `count`.| |selectHosts|query|Retorna uma propriedade [`hosts`](/manual/api/reference/host/object) com uma matriz de hosts aos quais a regra de LLD pertence.| |selectItems|query|Retorna uma propriedade [`items`](/manual/api/reference/item/object) com protótipos de item que pertencem à regra de LLD.

Suporta `count`.| |selectTriggers|query|Retorna uma propriedade [`triggers`](/manual/api/reference/trigger/object) com protótipos de trigger que pertencem à regra de LLD.

Suporta `count`.| |selectLLDMacroPaths|query|Retorna uma propriedade [`lld_macro_paths`](/manual/api/reference/discoveryrule/object#lld-macro-path) com uma lista de macros de LLD e caminhos para os valores atribuídos a cada macro correspondente.| |selectPreprocessing|query|Retorna uma propriedade [`preprocessing`](/manual/api/reference/discoveryrule/object#lld-rule-preprocessing) com opções de pré-processamento da regra de LLD.| |selectOverrides|query|Retorna uma propriedade [`lld_rule_overrides`](/manual/api/reference/discoveryrule/object#lld-rule-overrides) com uma lista de filtros, condições e operações de substituição executadas em objetos de protótipo.| |filter|object|Retorna apenas os resultados que correspondem exatamente ao filtro informado.

Aceita um objeto, em que as chaves são nomes de propriedades e os valores são um único valor ou uma matriz de valores para comparação.

Não suporta propriedades do [tipo de dado](/manual/api/reference_commentary#data-types) `text`.

Suporta propriedades adicionais:
`host` - nome técnico do host ao qual a regra de LLD pertence.| |limitSelects|integer|Limita o número de registros retornados pelos subselects.

Aplica-se aos seguintes subselects: `selectItems`, `selectGraphs`, `selectTriggers`.| |sortfield|string/array|Classifica o resultado pelas propriedades informadas.

Valores possíveis: `itemid`, `name`, `key_`, `delay`, `type`, `status`.| |countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/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]: # ({/83f48154-57007d3d}) [comment]: # ({7223bab1-7223bab1}) ### Valores de retorno `(integer/array)` Retorna um dos seguintes: - um array de objetos; - a contagem dos objetos recuperados, se o parâmetro `countOutput` tiver sido usado. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({f33ed0e3-5f8b5429}) #### Recuperando regras de descoberta de um host Recupere todas as regras de descoberta para um ID de host específico. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": "extend", "hostids": "10202" }, "id": 1 } ``` Response: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "27425", "type": "0", "snmp_oid": "", "hostid": "10202", "name": "Descoberta de interface de rede", "key_": "net.if.discovery", "delay": "1h", "status": "0", "trapper_hosts": "", "templateid": "22444", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "interfaceid": "119", "description": "Descoberta de interfaces de rede conforme definido na expressão regular global \"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": "Descoberta de sistema de arquivos montado", "key_": "vfs.fs.discovery", "delay": "1h", "status": "0", "trapper_hosts": "", "templateid": "22450", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "interfaceid": "119", "description": "Descoberta de sistemas de arquivos de diferentes tipos conforme definido na expressão regular global \"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]: # ({/f33ed0e3-5f8b5429}) [comment]: # ({22ef0184-4d0af030}) #### Recuperando condições de filtro Recupere o nome da regra LLD "24681" e suas condições de filtro. O filtro usa o tipo de avaliação "and", portanto a propriedade `formula` está vazia e `eval_formula` é gerada automaticamente. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "selectFilter": "extend", "itemids": ["24681"] }, "id": 1 } ``` Resposta: ```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]: # ({bdb61f34-e3de6fe8}) #### Recuperar regra de LLD por URL Recupera a regra de LLD do host pelo valor do campo URL da regra. Apenas correspondência exata da string de URL definida para a regra de LLD é suportada. [Request](/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 } ``` Resposta: ```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": "", "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]: # ({/bdb61f34-e3de6fe8}) [comment]: # ({cbbe028e-c0ae2d21}) #### Recuperar regra de LLD com substituições Recupera uma regra de LLD que possui várias configurações de substituição. [Requisição](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "discoveryrule.get", "params": { "output": ["name"], "itemids": "30980", "selectOverrides": ["name", "step", "stop", "filter", "operations"] }, "id": 1 } ``` Resposta: ```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}) ### Veja também - [Protótipo de gráfico](/manual/api/reference/graphprototype/object#graph-prototype) - [Host](/manual/api/reference/host/object#host) - [Protótipo de item](/manual/api/reference/itemprototype/object#item-prototype) - [Filtro de regra LLD](object#lld-rule-filter) - [Protótipo de trigger](/manual/api/reference/triggerprototype/object#trigger-prototype) [comment]: # ({/590f198c-f25d02bb}) [comment]: # ({e14efed8-e14efed8}) ### Fonte CDiscoveryRule::get() em *ui/include/classes/api/services/CDiscoveryRule.php*. [comment]: # ({/e14efed8-e14efed8})