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 que definem a saída desejada.

O método oferece suporte aos parâmetros a seguir.

Parâmetro Tipo Descrição
itemids string/array Retorna apenas 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 modelos fornecidos.
hostids string/array Retorna apenas os itens que pertencem aos hosts fornecidos.
proxyids string/array Retorna apenas os itens que são monitorados pelos proxies fornecidos.
interfaceids string/array Retorna apenas itens que usam as interfaces de host especificadas.
graphids string/array Retorna apenas os itens que são usados nos gráficos fornecidos.
triggerids string/array Retorna apenas os itens usados nos gatilhos fornecidos.
webitems flag Incluir itens da web no resultado.
inherited boolean Se definido como true, retornará apenas itens herdados de um modelo.
templated boolean Se definido como true, retornará apenas os itens que pertencem aos modelos.
monitored boolean Se definido como true, retornará apenas os itens habilitados que pertencem aos 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 pesquisa de tags.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.
tags array of objects Retorna apenas itens com as tags fornecidas. Correspondência exata por tag e pesquisa com distinção entre maiúsculas e minúsculas por valor de tag, dependendo do valor do operador.
Formato: [{"tag": "<tag>", "value": "<value>", " operator": "<operator>"}, ...].
Um array vazio retorna todos os itens.

Possíveis tipos de operadores:
0 - (padrão) Like;
1 - Igual;
2 - Diferente;
3 - Não igual
4 - Existe;
5 - Não existe.
with_triggers boolean Se definido como true, retorne apenas os itens que são usados em gatilhos.
selectHosts query Retorne uma propriedade hosts com uma matriz de hosts aos quais o item pertence.
selectInterfaces query Retorne uma propriedade de interfaces com uma matriz de interfaces de host usadas pelo item.
selectTriggers query Retorne uma propriedade triggers com os gatilhos nos quais o item é usado.

Suporta count.
selectGraphs query Retorne uma propriedade graphs com os gráficos que contêm o item.

Suporta count.
selectDiscoveryRule query Retorne uma propriedade discoveryRule com a regra LLD que criou o item.
selectItemDiscovery query Retorne uma propriedade itemDiscovery com o objeto de descoberta de item. O objeto de descoberta de item vincula o item a um protótipo de item a partir do qual ele foi criado.

Ele tem as seguintes propriedades:
itemdiscoveryid - (string) ID da descoberta de item;
itemid - (string) ID do item descoberto;
parent_itemid - (string) ID do protótipo do item a partir do qual o item foi criado;
key_ - (string ) chave do protótipo do item;
lastcheck - (timestamp) hora em que o item foi descoberto pela última vez;
ts_delete - (timestamp) hora em que um item que não é mais descoberto será ser excluído.
selectPreprocessing query Retorna uma propriedade de pré-processamento com opções de pré-processamento de item.

Tem as seguintes propriedades:
type - (string) O tipo de opção de pré-processamento:
1 - Multiplicador personalizado;
2 - Aparar à direita;
3 - Aparar à esquerda;
4 - Aparar;
5 - Correspondência de expressão regular;< br>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 - No intervalo;
14 - Corresponde à expressão regular;
15 - Não corresponde à expressão regular;
16 - Verifique se há erro no JSON;
17 - Verificar erro no XML;
18 - Verificar erro usando expressão regular;
19 - Descartar inalterado;
20 - Descartar inalterado com pulsação;
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 - (st ring) 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 usado 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 erro.
selectTags query Retorne as tags do item na propriedade tags.
selectValueMap query Retorne uma propriedade valuemap com o mapa de valor do item.
filter object Retorna apenas os resultados que correspondem exatamente ao filtro fornecido.

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

Suporta filtros adicionais:
host - nome técnico do host ao qual o item pertence.
limitSelects integer Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectGraphs - os resultados serão classificados por name;
selectTriggers - resultados será ordenado por descrição.
sortfield string/array Classifique o resultado pelas propriedades fornecidas.

Os valores possíveis são: itemid, name, key_, delay, history, trends, type e status.
countOutput boolean Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes na página comentário de referência.
editável booleano
excludePesquisa boolean
limite inteiro
saída consulta
preservekeys boolean
pesquisar objeto
searchByAny boolean
searchWildcardsEnabled boolean
ordem de classificação cadeia/matriz
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Encontrando itens por chave

Recupere todos os itens do host com ID "10084" que tenham a palavra "sistema" na chave e classifique-os por nome.

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "item.get",
    "parâmetros": {
        "saída": "estender",
        "hostids": "10084",
        "procurar": {
            "sistema chave"
        },
        "sortfield": "nome"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "itemid": "23298",
            "tipo": "0",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "Mudanças de contexto por segundo",
            "key_": "system.cpu.switches",
            "atraso": "1m",
            "história": "7d",
            "tendências": "365d",
            "lastvalue": "2552",
            "último relógio": "1351090998",
            "valor anterior": "2641",
            "estado": "0",
            "estado": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "unidades": "sp",
            "erro": "",
            "logtimefmt": "",
            "templateid": "22680",
            "valuemap": "0",
            "parâmetros": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "nome do usuário": "",
            "senha": "",
            "chave pública": "",
            "chave privada": "",
            "lastns": "564054253",
            "bandeiras": "0",
            "interfaceid": "1",
            "Descrição": "",
            "link_inventário": "0",
            "vida": "0s",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "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",
            "parâmetros": []
        },
        {
            "itemid": "23299",
            "tipo": "0",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "CPU $ 2 vezes",
            "key_": "system.cpu.util[,idle]",
            "atraso": "1m",
            "história": "7d",
            "tendências": "365d",
            "lastvalue": "86.031879",
            "lastclock": "1351090999",
            "valor anterior": "85.306944",
            "estado": "0",
            "estado": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "unidades": "%",
            "erro": "",
            "logtimefmt": "",
            "modeloid": "17354",
            "valuemap": "0",
            "parâmetros": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "nome do usuário": "",
            "senha": "",
            "chave pública": "",
            "chave privada": "",
            "lastns": "564256864",
            "bandeiras": "0",
            "interfaceid": "1",
            "description": "O tempo que a CPU passou sem fazer nada.",
            "link_inventário": "0",
            "vida": "0s",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "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",
            "parâmetros": []
        },
        {
            "itemid": "23300",
            "tipo": "0",
            "snmp_oid": "",
            "hostid": "10084",
            "name": "CPU $ 2 vezes",
            "key_": "system.cpu.util[,interromper]",
            "história": "7d",
            "tendências": "365d",
            "lastvalue": "0,008389",
            "lastclock": "1351091000",
            "valor anterior": "0,000000",
            "estado": "0",
            "estado": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "unidades": "%",
            "erro": "",
            "logtimefmt": "",
            "modeloid": "22671",
            "valuemap": "0",
            "parâmetros": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "nome do usuário": "",
            "senha": "",
            "chave pública": "",
            "chave privada": "",
            "lastns": "564661387",
            "bandeiras": "0",
            "interfaceid": "1",
            "description": "A quantidade de tempo que a CPU está atendendo a interrupções de hardware.",
            "link_inventário": "0",
            "vida": "0s",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "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",
            "parâmetros": []
        }
    ],
    "id": 1
}

Encontrando itens dependentes por chave

Recupere todos os itens dependentes do host com ID "10116" que tenham o 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.