Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Únase a nuestro proyecto de traducción y ayude a traducir la documentación de Zabbix a su lengua materna.

item.get

Descripción

integer/array item.get(object parameters)

El método permite recuperar métricas según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
itemids cadena/matriz Devuelve solo métricas con los ID proporcionados.
groupids cadena/matriz Devuelve solo métricas que pertenecen a los equipos de los grupos dados.
templateids cadena/matriz Devuelve sólo métricas que pertenecen a las plantillas dadas.
hostids cadena/matriz Devuelve sólo métricas que pertenecen a los equipos dados.
proxyids cadena/matriz Devuelve sólo métricas que son monitoreados por los proxies dados.
interfaceids cadena/matriz Devuelve sólo métricas que utilizan las interfaces de equipo dadas.
graphids cadena/matriz Devuelve solo las métricas que se utilizan en los gráficos dados.
triggerids cadena/matriz Devuelve solo las métricas que se utilizan en los iniciadores dados.
webitems flag Incluir elementos web en el resultado.
inherited booleano Si se establece en "verdadero", devuelve solo los elementos heredados de una plantilla.
templated booleano Si se establece en "verdadero", devuelve solo las métricas que pertenecen a las plantillas.
monitored booleano Si se establece en "verdadero", solo se devuelven métricas habilitadas que pertenecen a equipos monitoreados.
group cadena Devuelve sólo métricas que pertenecen a un grupo con el nombre dado.
host cadena Devuelve sólo métricas que pertenecen a un equipo con el nombre dado.
evaltype entero Reglas para la búsqueda de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
tags matriz de objetos Devuelve solo métricas con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].
Una matriz vacía devuelve todos las métricas.

Tipos de operadores posibles:
0 - (predeterminado) Like;
1 - Igual;
2 - Not like;
3 - No igual
4 - Existe;
5 - No existe.
with_triggers booleano Si se establece en true, se devuelven solo las métricas que se utilizan en los iniciadores.
selectHosts query Devuelve una propiedad hosts con una matriz de equipos a los que pertenece la métrica.
selectInterfaces query Devuelve una propiedad interfaces con una matriz de interfaces de equipo utilizadas por la métrica.
selectTriggers query Devuelve una propiedad triggers con los iniciadores en los que se utiliza la métrica.

Admite count.
selectGraphs query Devuelve una propiedad graphs con los gráficos que contienen la métrica.

Admite count.
selectDiscoveryRule query Devuelve una propiedad discoveryRule con la regla LLD que creó el elemento.
selectItemDiscovery query Devuelve una propiedad itemDiscovery con el objeto de descubrimiento de métricas. El objeto de descubrimiento de métricas vincula la métrica a un prototipo de métrica a partir del cual se creó.

Tiene las siguientes propiedades:
itemdiscoveryid - (string) ID del descubrimiento de métricas;
itemid - (string) ID de la métrica descubierta;
parent_itemid - (string) ID del prototipo del métrica a partir del cual se creó la métrica;
key_ - (string) )clave del prototipo de la métrica;
lastcheck-(marca de tiempo)hora en que se descubrió la métrica por última vez;
ts_delete-(marca de tiempo)hora en que una métrica que ya no se descubre será eliminada.| |selectPreprocessing|query|Devuelve una propiedad [preprocessing](/manual/api/reference/item/object#item_preprocessing) con opciones de preprocesamiento de métrica.

Tiene las siguientes propiedades:
type-(cadena)El tipo de opción de preprocesamiento:
1 - Multiplicador personalizado;
2 - Recorte derecho;
3 - Recorte izquierdo;
4 - Recortar;
5 - Expresión regular;
6 - Booleano a decimal;
7 - Octal a decimal;
8 - Hexadecimal a decimal;
9 - Cambio simple;
10 - Cambio por segundo;
11 - XML XPath;
12 - JSONPath;
13 - Dentro del rango;
14 - Coincide con la expresión regular;
15 - No coincide con la expresión regular;
16 - Comprueba si hay errores en JSON;<br >17 - Verificar errores en XML;
18 - Verificar errores usando expresiones regulares;
19 - Descartar sin cambios;
20 - Descartar sin cambios con un latido;
21 - JavaScript;
22 - Patrón Prometheus;
23 - Prometheus a JSON;
24 - CSV a JSON;
25 - Reemplazar;
26 - Verificar valor no admitido;
27 - XML a JSON;< br>28 - Valor de SNMP walk;
29 - SNMP walk a JSON.
params-(cadena)Parámetros adicionales utilizados por la opción de preprocesamiento. Múltiples parámetros están separados por el carácter de nueva línea (\\n).
error_handler-(string)Tipo de acción utilizado en caso de falla en el paso de preprocesamiento:
0 - El mensaje de error lo establece el servidor Zabbix;< br>1 - Descartar valor;
2 - Establecer valor personalizado;
3 - Establecer mensaje de error personalizado.
error_handler_params-(string)Parámetros del controlador de errores.| |selectTags|query|Devuelve las etiquetas de métrica en la propiedad [tags](/manual/api/reference/item/object#Item_tag).| |selectValueMap|consulta|Devuelve una propiedad [valuemap](/manual/api/reference/valuemap/object) con el mapa de valores de métrica.| |filter|objeto|Devuelve sólo aquellos resultados que coinciden exactamente con el filtro dado.

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

Admite filtros adicionales:
host: nombre técnico del equipo al que pertenece el elemento.| |limitSelects|entero|Limita el número de registros devueltos por las subselecciones.

Se aplica a las siguientes subselecciones:
selectGraphs: los resultados se ordenarán pornombre;
selectTriggers: resultados se ordenará pordescripción.| |sortfield|cadena/matriz|Ordena el resultado por las propiedades dadas.

Valores posibles:
itemid,name,key_,delay,history,trends,type ,estado.| |countOutput|booleano|Estos parámetros, que son comunes para todos los métodosget`, se describen en detalle en la página comentario de referencia.
editable booleano
excludeSearch booleano
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch booleano

Valores de devueltos

(integer/array) Returns either:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetros countOutput está siendo usado

Ejemplos

Buscando métricas por clave

Obtiene todas las métricas usadas en iniciadores de unos determinados ID de equipo que tienen la palabra "system.cpu" en la clave de la métrica y ordena los resultados por nombre.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "item.get",
           "params": {
               "output": "extend",
               "hostids": "10084",
               "with_triggers": true,
               "search": {
                   "key_": "system.cpu"
               },
               "sortfield": "name"
           },
           "id": 1
       }

Respuesta:

{
           "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": "3s",
                   "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"
               },
               {
                   "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": "3s",
                   "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"
               },
               {
                   "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": "3s",
                   "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"
               },
               {
                   "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": "3s",
                   "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"
               },
               {
                   "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": "3s",
                   "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"
               }
           ],
           "id": 1
       }

Encontrar métricas dependientes por clave

Recupere todas las métricas dependientes del equipo con ID "10116" que tengan la palabra "apache" en la clave.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "item.get",
           "params": {
               "output": "extend",
               "hostids": "10116",
               "search": {
                   "key_": "apache"
               },
               "filter": {
                   "type": 18
               }
           },
           "id": 1
       }

Respuesta:

{
           "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": "3s",
                   "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"
               },
               {
                   "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": "3s",
                   "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"
               }
           ],
           "id": 1
       }

Buscar métrica del agente HTTP

Busque métricas del agente HTTP con el tipo de cuerpo de la publicación XML para una ID de equipo específica.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "item.get",
           "params": {
               "hostids": "10255",
               "filter": {
                   "type": 19,
                   "post_type": 3
               }
           },
           "id": 1
       }

Respuesta:

{
           "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": "3s",
                   "url": "localhost",
                   "query_fields": [
                       {
                           "mode": "xml"
                       }
                   ],
                   "posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
                   "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": ""
               }
           ],
           "id": 1
       }

Recuperar métricas con reglas de preprocesamiento

Recupere todas las métricas y sus reglas de preprocesamiento para una ID de equipo específica.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "item.get",
           "params": {
               "output": ["itemid", "name", "key_"],
               "selectPreprocessing": "extend",
               "hostids": "10254"
           },
           "id": 1
       }

Respuesta:

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

Ver también

Fuente

CItem::get() en ui/include/classes/api/services/CItem.php.