[comment]: # ({58fbd3bc-58fbd3bc}) # item.get [comment]: # ({/58fbd3bc-58fbd3bc}) [comment]: # ({14484745-673edf7f}) ### Descripción `integer/array item.get(object parameters)` El método permite recuperar items según los parámetros proporcionados. ::: noteclassic Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte [Roles de usuario](/manual/web_interface/frontend_sections/users/user_roles) para obtener más información. ::: [comment]: # ({/14484745-673edf7f}) [comment]: # ({641397fb-cc946363}) ### Parámetros `(object)` Parámetros que definen la salida deseada. El método admite los siguientes parámetros. |Parameter|[Type](/manual/api/reference_commentary#data-types)|Description| |--|--|------| |itemids|ID/array|Devuelve solo los items con los IDs dados.| |groupids|ID/array|Devuelve solo los items que pertenecen a los hosts de los grupos dados.| |templateids|ID/array|Devuelve solo los items que pertenecen a los templates dados.| |hostids|ID/array|Devuelve solo los items que pertenecen a los hosts dados.| |proxyids|ID/array|Devuelve solo los items que son monitorizados por los proxies dados.| |interfaceids|ID/array|Devuelve solo los items que usan las interfaces de host dadas.| |graphids|ID/array|Devuelve solo los items que se usan en los graphs dados.| |triggerids|ID/array|Devuelve solo los items que se usan en los triggers dados.| |webitems|flag|Incluye web items en el resultado.| |inherited|boolean|Si se establece en `true`, devuelve solo los items heredados de un template.| |templated|boolean|Si se establece en `true`, devuelve solo los items que pertenecen a templates.| |monitored|boolean|Si se establece en `true`, devuelve solo los items habilitados que pertenecen a hosts monitorizados.| |group|string|Devuelve solo los items que pertenecen a un grupo con el nombre dado.| |host|string|Devuelve solo los items que pertenecen a un host con el nombre dado.| |evaltype|integer|Método de [evaluación de etiquetas](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter).

Valores posibles:
0 - *(predeterminado)* And/Or;
2 - Or.| |tags|array|Devuelve solo los items con las etiquetas dadas.
Formato: `[{"tag": "", "value": "", "operator": ""}, ...]`.
Un array vacío devuelve todos los items.

Valores posibles de [operator](/manual/web_interface/frontend_sections/data_collection/hosts/items#using-filter):
0 - *(predeterminado)* Contiene;
1 - Igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.| |with\_triggers|boolean|Si se establece en `true`, devuelve solo los items que se usan en triggers.| |selectHosts|query|Devuelve una propiedad [`hosts`](/manual/api/reference/host/object) con un array de hosts a los que pertenece el item.| |selectInterfaces|query|Devuelve una propiedad [`interfaces`](/manual/api/reference/hostinterface/object) con un array de interfaces de host usadas por el item.| |selectTriggers|query|Devuelve una propiedad [`triggers`](/manual/api/reference/trigger/object) con los triggers en los que se usa el item.

Admite `count`.| |selectGraphs|query|Devuelve una propiedad [`graphs`](/manual/api/reference/graph/object) con los graphs que contienen el item.

Admite `count`.| |selectDiscoveryData|query|Devuelve una propiedad `discoveryData` con los datos del objeto de descubrimiento del item. El objeto de descubrimiento del item vincula un item descubierto con un prototipo de item del que fue descubierto.

Tiene las siguientes propiedades:
`parent_itemid` - `(string)` ID del prototipo de item a partir del cual se ha creado el item;
`key_` - `(string)` clave del prototipo de item;
`status` - `(int)` estado del descubrimiento del item:
0 - *(predeterminado)* el item está descubierto,
1 - el item ya no está descubierto;
`ts_delete` - `(timestamp)` momento en que se eliminará un item que ya no está descubierto;
`ts_disable` - `(timestamp)` momento en que se deshabilitará un item que ya no está descubierto;
`disable_source` - `(int)` indicador de si el item fue deshabilitado por una regla LLD o manualmente:
0 - *(predeterminado)* deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.| |selectDiscoveryRule|query|Devuelve una propiedad [`discoveryRule`](/manual/api/reference/discoveryrule/object) con la regla LLD que creó el item.| |selectPreprocessing|query|Devuelve una propiedad [`preprocessing`](/manual/api/reference/item/object#item-preprocessing) con las opciones de preprocesamiento del item.| |selectTags|query|Devuelve las etiquetas del item en la propiedad [`tags`](/manual/api/reference/item/object#item-tag).| |selectValueMap|query|Devuelve una propiedad [`valuemap`](/manual/api/reference/valuemap/object) con el mapa de valores del item.| |filter|object|Devuelve solo los resultados que coinciden exactamente con el filtro dado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar.

No admite propiedades de tipo de datos `text` [data type](/manual/api/reference_commentary#data-types).

Admite propiedades adicionales:
`host` - nombre técnico del host al que pertenece el item.| |limitSelects|integer|Limita el número de registros devueltos por las subconsultas.

Se aplica a las siguientes subconsultas:
`selectGraphs` - los resultados se ordenarán por `name`;
`selectTriggers` - los resultados se ordenarán por `description`.| |sortfield|string/array|Ordena el resultado por las propiedades dadas.

Valores posibles: `itemid`, `name`, `key_`, `delay`, `history`, `trends`, `type`, `status`.| |countOutput|boolean|Estos parámetros se describen en el [reference commentary](/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|^| |selectItemDiscovery|query|Devuelve una propiedad `itemDiscovery` con el objeto de descubrimiento del item. El objeto de descubrimiento del item vincula el item con un prototipo de item del que fue creado.

Esta consulta está **obsoleta**; use `selectDiscoveryData` en su lugar.| [comment]: # ({/641397fb-cc946363}) [comment]: # ({7223bab1-7223bab1}) ### Valores de retorno `(integer/array)` Devuelve cualquiera de los siguientes: - un array de objetos; - el número de objetos recuperados, si se ha utilizado el parámetro `countOutput`. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Ejemplos [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({1a09225b-59b84d93}) #### Búsqueda de items por clave Recupera todos los items utilizados en triggers para un ID de host específico que tengan la palabra "system.cpu" en la clave del item y ordena los resultados por nombre. [Solicitud](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10084", "with_triggers": true, "search": { "key_": "system.cpu" }, "sortfield": "name" }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "42269", "type": "18", "snmp_oid": "", "hostid": "10084", "name": "CPU utilization", "key_": "system.cpu.util", "delay": "0", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "%", "logtimefmt": "", "templateid": "42267", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "CPU utilization in %.", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "42264", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "CPU utilization" }, { "itemid": "42259", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (15m avg)", "key_": "system.cpu.load[all,avg15]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42219", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "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", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (15m avg)" }, { "itemid": "42249", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (1m avg)", "key_": "system.cpu.load[all,avg1]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42209", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "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", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (1m avg)" }, { "itemid": "42257", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Load average (5m avg)", "key_": "system.cpu.load[all,avg5]", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "0", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42217", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "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", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Load average (5m avg)" }, { "itemid": "42260", "type": "0", "snmp_oid": "", "hostid": "10084", "name": "Number of CPUs", "key_": "system.cpu.num", "delay": "1m", "history": "7d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "42220", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "1", "description": "", "inventory_link": "0", "evaltype": "0", "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", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Number of CPUs" } ], "id": 1 } ``` [comment]: # ({/1a09225b-59b84d93}) [comment]: # ({a6ae1426-674b0856}) #### Encontrar items dependientes por clave Recupere todos los items dependientes del host con ID "10116" que tengan la palabra "apache" en la clave. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": "extend", "hostids": "10116", "search": { "key_": "apache" }, "filter": { "type": 18 } }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "25550", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Days", "key_": "apache.status.uptime.days", "delay": "0", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Days" }, { "itemid": "25555", "type": "18", "snmp_oid": "", "hostid": "10116", "name": "Hours", "key_": "apache.status.uptime.hours", "delay": "0", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "25545", "timeout": "", "url": "", "query_fields": [], "posts": "", "status_codes": "200", "follow_redirects": "1", "post_type": "0", "http_proxy": "", "headers": [], "retrieve_mode": "0", "request_method": "0", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "0", "prevvalue": "0", "name_resolved": "Hours" } ], "id": 1 } ``` [comment]: # ({/a6ae1426-674b0856}) [comment]: # ({256e2a05-94dc4b21}) #### Encontrar item de HTTP agent Encontrar item de HTTP agent con tipo de cuerpo de publicación XML para un ID de host específico. [Request](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "hostids": "10255", "filter": { "type": 19, "post_type": 3 } }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": [ { "itemid": "28252", "type": "19", "snmp_oid": "", "hostid": "10255", "name": "template item", "key_": "ti", "delay": "30s", "history": "90d", "trends": "365d", "status": "0", "value_type": "3", "trapper_hosts": "", "units": "", "logtimefmt": "", "templateid": "0", "valuemapid": "0", "params": "", "ipmi_sensor": "", "authtype": "0", "username": "", "password": "", "publickey": "", "privatekey": "", "flags": "0", "interfaceid": "0", "description": "", "inventory_link": "0", "evaltype": "0", "jmx_endpoint": "", "master_itemid": "0", "timeout": "", "url": "localhost", "query_fields": [ { "name": "mode", "value": "xml" } ], "posts": "\r\n]]>\r\n", "status_codes": "200", "follow_redirects": "0", "post_type": "3", "http_proxy": "", "headers": [], "retrieve_mode": "1", "request_method": "3", "output_format": "0", "ssl_cert_file": "", "ssl_key_file": "", "ssl_key_password": "", "verify_peer": "0", "verify_host": "0", "allow_traps": "0", "uuid": "", "state": "0", "error": "", "parameters": [], "lastclock": "0", "lastns": "0", "lastvalue": "", "prevvalue": "", "name_resolved": "template item" } ], "id": 1 } ``` [comment]: # ({/256e2a05-94dc4b21}) [comment]: # ({6697de6d-f4b01bbe}) #### Recuperar métricas con reglas de preprocesamiento Recuperar todas las métricas y sus reglas de preprocesamiento para un ID de equipo específico. [Solicitud](/manual/api#performing-requests): ```json { "jsonrpc": "2.0", "method": "item.get", "params": { "output": ["itemid", "name", "key_"], "selectPreprocessing": "extend", "hostids": "10254" }, "id": 1 } ``` Respuesta: ```json { "jsonrpc": "2.0", "result": { "itemid": "23865", "name": "HTTP agent example JSON", "key_": "json", "preprocessing": [ { "type": "12", "params": "$.random", "error_handler": "1", "error_handler_params": "" } ] }, "id": 1 } ``` [comment]: # ({/6697de6d-f4b01bbe}) [comment]: # ({8d9fbd3b-d3276b35}) ### Ver también - [Regla de descubrimiento](/manual/api/reference/discoveryrule/object#discovery-rule) - [Gráfico](/manual/api/reference/graph/object#graph) - [Host](/manual/api/reference/host/object#host) - [Interfaz de host](/manual/api/reference/hostinterface/object#host-interface) - [Trigger](/manual/api/reference/trigger/object#trigger) [comment]: # ({/8d9fbd3b-d3276b35}) [comment]: # ({a6ef1d0f-a6ef1d0f}) ### Fuente CItem::get() en *ui/include/classes/api/services/CItem.php*. [comment]: # ({/a6ef1d0f-a6ef1d0f})