Table of Contents
item.get
Descrição
integer/array item.get(object parameters)
O método permite recuperar itens de acordo com os parâmetros fornecidos.
Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.
Parâmetros
(object) Parâmetros definem as saídas desejadas. O método suporta os seguintes parâmetros:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| itemids | string/array | Retorna apenas os itens com os IDs fornecidos. |
| groupids | string/array | Retorna apenas os itens que pertencem aos hosts dos grupos fornecidos. |
| templateids | string/array | Retorna apenas os itens que pertencem aos templates fornecidos. |
| hostids | string/array | Retorna apenas os itens que pertencem aos hosts fornecidos. |
| proxyids | string/array | Retorna apenas os itens monitorados pelos proxies fornecidos. |
| interfaceids | string/array | Retorna apenas os itens que usam as interfaces de host fornecidas. |
| graphids | string/array | Retorna apenas os itens utilizados nos gráficos fornecidos. |
| triggerids | string/array | Retorna apenas os itens utilizados nos triggers fornecidos. |
| webitems | flag | Inclui itens web no resultado. |
| inherited | boolean | Se definido como true, retorna apenas os itens herdados de um template. |
| templated | boolean | Se definido comotrue, retorna apenas os itens que pertencem a templates. |
| monitored | boolean | Se definido como true, retorna apenas os itens habilitados que pertencem a hosts monitorados. |
| group | string | Retorna apenas os itens que pertencem a um grupo com o nome fornecido. |
| host | string | Retorna apenas os itens que pertencem a um host com o nome fornecido. |
| evaltype | integer | Regras para busca por tags. Valores possíveis: 0 - (padrão) E/Ou; 2 - Ou. |
| tags | array de objects | Retorna apenas os itens com as tags fornecidas. Correspondência exata por tag e busca sensível ou insensível a maiúsculas e minúsculas pelo valor da tag, dependendo do operador. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Um array vazio retorna todos os itens. Tipos de operadores possíveis: 0 - (padrão) Like; 1 - Igual; 2 - Não like; 3 - Não é igual 4 - Existe; 5 - Não existe. |
| with_triggers | boolean | Se definido como true, retorna apenas os itens usados em triggers. |
| selectHosts | query | Retorna uma propriedade hosts com um array de hosts aos quais o item pertence. |
| selectInterfaces | query | Retorna uma propriedade interfaces com um array de interfaces de host usadas pelo item. |
| selectTriggers | query | Retorna uma propriedade triggers com os triggers nos quais o item é usado. Suporta count. |
| selectGraphs | query | Retorna uma propriedade graphs com os gráficos que contêm o item. Suporta count. |
| selectDiscoveryRule | query | Retorna uma propriedade discoveryRule com a regra LLD que criou o item. |
| selectItemDiscovery | query | Retorna uma propriedade itemDiscovery com o objeto de descoberta do item. O objeto de descoberta do item vincula o item a um protótipo de item do qual foi criado.Ele tem as seguintes propriedades: itemdiscoveryid - (string) ID da descoberta do item;itemid - (string) ID do item descoberto;parent_itemid - (string) ID do protótipo de item a partir do qual o item foi criado;key_ - (string) chave do protótipo de item;lastcheck - (timestamp) hora da última descoberta do item;ts_delete - (timestamp) hora em que um item não mais descoberto será excluído. |
| selectPreprocessing | query | Retorna uma propriedade preprocessing com as opções de pré-processamento do item. Ela tem as seguintes propriedades: type - (string) Tipo de opção de pré-processamento:1 - Multiplicador personalizado; 2 - Cortar à direita; 3 - Cortar à esquerda; 4 - Cortar; 5 - Correspondência de expressão regular; 6 - Booleano para decimal; 7 - Octal para decimal; 8 - Hexadecimal para decimal; 9 - Alteração simples; 10 - Alteração por segundo; 11 - XML XPath; 12 - JSONPath; 13 - Em intervalo; 14 - Corresponde à expressão regular; 15 - Não corresponde à expressão regular; 16 - Verificar erro no JSON; 17 - Verificar erro no XML; 18 - Verificar erro usando expressão regular; 19 - Descartar sem alteração; 20 - Descartar sem alteração com heartbeat; 21 - JavaScript; 22 - Padrão Prometheus; 23 - Prometheus para JSON; 24 - CSV para JSON; 25 - Substituir; 26 - Verificar valor não suportado; 27 - XML para JSON. params - (string) Parâmetros adicionais usados pela opção de pré-processamento. Vários parâmetros são separados pelo caractere LF (\n).error_handler - (string) Tipo de ação usada em caso de falha na etapa de pré-processamento:0 - Mensagem de erro definida pelo servidor Zabbix; 1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. error_handler_params - (string) Parâmetros do manipulador de erros. |
| selectTags | query | Retorna as tags do item na propriedade tags. |
| selectValueMap | query | Retorna uma propriedade valuemap com o mapa de valores do item. |
| filter | object | Retorna apenas os resultados que correspondem exatamente ao filtro fornecido. Aceita um array, onde as chaves são nomes de propriedades e os valores são um único valor ou um array de valores para correspondência. Suporta filtros adicionais: host - nome técnico do host ao qual o item pertence. |
| limitSelects | integer | Limita o número de registros retornados por subconsultas. Aplica-se às seguintes subconsultas: selectGraphs - os resultados serão classificados por name;selectTriggers - os resultados serão classificados por description. |
| sortfield | string/array | Classifica o resultado pelas propriedades fornecidas. Valores possíveis são: itemid, name, key_, delay, history, trends, type e status. |
| countOutput | boolean | Esses parâmetros, sendo comuns a todos os métodos get, são descritos em detalhes na página de reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Encontrar itens por chave
Recupera todos os itens usados em triggers de um host específico que contêm a palavra "system.cpu" na chave do item e ordena os resultados pelo nome.
Solicitação:
{
"jsonrpc": "2.0",
"method": "item.get",
"params": {
"output": "extend",
"hostids": "10084",
"with_triggers": true,
"search": {
"key_": "system.cpu"
},
"sortfield": "name"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"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
}Encontrando itens dependentes por chave
Recupere todos os itens dependentes do host com ID "10116" que tenham a palavra "apache" na chave.
Solicitação:
{
"jsonrpc": "2.0",
"método": "item.get",
"parâmetros": {
"saída": "estender",
"hostids": "10116",
"procurar": {
"key_": "apache"
},
"filtro": {
"tipo": "18"
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"itemid": "25550",
"tipo": "18",
"snmp_oid": "",
"hostid": "10116",
"nome": "Dias",
"key_": "apache.status.uptime.days",
"atraso": "",
"história": "90d",
"tendências": "365d",
"estado": "0",
"value_type": "3",
"trapper_hosts": "",
"unidades": "",
"Fórmula": "",
"erro": "",
"logtimefmt": "",
"templateid": "0",
"valuemap": "0",
"parâmetros": "",
"ipmi_sensor": "",
"authtype": "0",
"nome do usuário": "",
"senha": "",
"chave pública": "",
"chave privada": "",
"bandeiras": "0",
"interfaceid": "0",
"Descrição": "",
"link_inventário": "0",
"vida": "30d",
"estado": "0",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"tempo limite": "3s",
"url": "",
"query_fields": [],
"Postagens": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"proxy HTTP": "",
"cabeçalhos": [],
"recuperar_modo": "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",
"último relógio": "0",
"últimos": "0",
"último valor": "0",
"valor anterior": "0",
"parâmetros": []
},
{
"itemid": "25555",
"tipo": "18",
"snmp_oid": "",
"hostid": "10116",
"nome": "Horas",
"key_": "apache.status.uptime.hours",
"atraso": "0",
"história": "90d",
"tendências": "365d",
"estado": "0",
"value_type": "3",
"trapper_hosts": "",
"unidades": "",
"Fórmula": "",
"erro": "",
"logtimefmt": "",
"templateid": "0",
"valuemap": "0",
"parâmetros": "",
"ipmi_sensor": "",
"authtype": "0",
"nome do usuário": "",
"senha": "",
"chave pública": "",
"chave privada": "",
"bandeiras": "0",
"interfaceid": "0",
"Descrição": "",
"link_inventário": "0",
"vida": "30d",
"estado": "0",
"evaltype": "0",
"master_itemid": "25545",
"jmx_endpoint": "",
"tempo limite": "3s",
"url": "",
"query_fields": [],
"Postagens": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"proxy HTTP": "",
"cabeçalhos": [],
"recuperar_modo": "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",
"último relógio": "0",
"últimos": "0",
"último valor": "0",
"valor anterior": "0",
"parâmetros": []
}
],
"id": 1
}Localizar item do agente HTTP
Encontre o item do agente HTTP com o XML do tipo de corpo da postagem para o ID do host específico.
Solicitação:
{
"jsonrpc": "2.0",
"método": "item.get",
"parâmetros": {
"hostids": "10255",
"filtro": {
"tipo": "19",
"post_type": "3"
}
},
"id": 3,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"itemid": "28252",
"tipo": "19",
"snmp_oid": "",
"hostid": "10255",
"name": "item de modelo",
"chave_": "ti",
"atraso": "30s",
"história": "90d",
"tendências": "365d",
"estado": "0",
"value_type": "3",
"trapper_hosts": "",
"unidades": "",
"Fórmula": "",
"erro": "",
"logtimefmt": "",
"templateid": "0",
"valuemap": "0",
"parâmetros": "",
"ipmi_sensor": "",
"authtype": "0",
"nome do usuário": "",
"senha": "",
"chave pública": "",
"chave privada": "",
"bandeiras": "0",
"interfaceid": "0",
"Descrição": "",
"link_inventário": "0",
"vida": "30d",
"estado": "0",
"evaltype": "0",
"jmx_endpoint": "",
"master_itemid": "0",
"tempo limite": "3s",
"url": "localhost",
"campos_consulta": [
{
"modo": "xml"
}
],
"posts": "<body>\r\n<![CDATA[{$MACRO}<foo></bar>]]>\r\n</body>",
"status_codes": "200",
"follow_redirects": "0",
"post_type": "3",
"proxy HTTP": "",
"cabeçalhos": [],
"recuperar_modo": "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",
"último relógio": "0",
"últimos": "0",
"último valor": "0",
"valor anterior": "0",
"parâmetros": []
}
],
"id": 3
}Recuperando itens com regras de pré-processamento
Recupere todos os itens e suas regras de pré-processamento do host com ID "10254".
Solicitação:
{
"jsonrpc": "2.0",
"método": "item.get",
"parâmetros": {
"output": ["itemid", "name", "key_"],
"selectPreprocessing": "estender",
"hostids": "10254"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": {
"itemid": "23865",
"name": "Exemplo de agente http JSON",
"key_": "json",
"pré-processando": [
{
"tipo": "12",
"params": "$.random",
"error_handler": "1",
"error_handler_params": ""
}
]
},
"id": 1
}Veja também
Fonte
CItem::get() em ui/include/classes/api/services/CItem.php.