Sidebar

Become a monitoring expert!
Sign up for Zabbix training

itemprototype.get

Descrição

integer/array itemprototype.get(object parameters)

O método permite recuperar protótipos de itens de acordo com o parâmetros.

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 seguintes parâmetros.

|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |discoveryids|string/array|Retorna apenas protótipos de itens que pertencem às regras LLD fornecidas.| |graphids|string/array|Retorna apenas protótipos de itens que são usados nos protótipos de gráficos fornecidos.| |hostids|string/array|Retorna apenas protótipos de itens que pertencem aos hosts fornecidos.| |inherited|boolean|Se definido como true, retornará apenas protótipos de itens herdados de um modelo.| |itemids|string/array|Retorna apenas protótipos de itens com os IDs fornecidos.| |monitored|boolean|Se definido como true retorna apenas protótipos de itens habilitados que pertencem a hosts monitorados.| |templated|boolean|Se definido como true, retornará apenas protótipos de itens que pertencem a templates.| |templateids|string/array|Retorna apenas protótipos de itens que pertencem aos modelos fornecidos.| |triggerids|string/array|Retorna apenas os protótipos de item que são usados nos protótipos de gatilho fornecidos.| |selectDiscoveryRule|query|Retorne uma propriedade discoveryRule com a regra de descoberta de baixo nível à qual o protótipo do item pertence.| |selectGraphs|query|Retorne uma propriedade manual/api/reference/graphprototype/object#graph_prototype com protótipos de gráfico nos quais o protótipo de item é usado.< br>
Suporta contagem.| |selectHosts|query|Retorne uma propriedade hosts com uma matriz de hosts aos quais o protótipo do item pertence.| |selectTags|query|Retorne as tags de protótipo do item na propriedade tags.| |selectTriggers|query|Retorne uma propriedade triggers com protótipos de gatilho nos quais o protótipo do item é usado.

Suporta count.| |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 - (str ing) 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.| |selectValueMap|query|Retorne uma propriedade valuemap com o mapa de valor do protótipo 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 protótipo do 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|Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: itemid, name, key_, delay, type e status.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no 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

Recuperando protótipos de itens de uma regra LLD

Recupere todos os protótipos de itens de uma regra LLD.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "itemprototype.get",
           "parâmetros": {
               "saída": "estender",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "itemid": "23077",
                   "tipo": "0",
                   "snmp_oid": "",
                   "hostid": "10079",
                   "name": "Tráfego de rede de entrada em en0",
                   "key_": "net.if.in[en0]",
                   "atraso": "1m",
                   "história": "1w",
                   "tendências": "365d",
                   "estado": "0",
                   "value_type": "3",
                   "trapper_hosts": "",
                   "unidades": "bps",
                   "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": "",
                   "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",
                   "descobrir": "0",
                   "parâmetros": []
               },
               {
                   "itemid": "10010",
                   "tipo": "0",
                   "snmp_oid": "",
                   "hostid": "10001",
                   "name": "Carga do processador (média de 1 min por núcleo)",
                   "key_": "system.cpu.load[percpu,avg1]",
                   "atraso": "1m",
                   "história": "1w",
                   "tendências": "365d",
                   "estado": "0",
                   "value_type": "0",
                   "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",
                   "description": "A carga do processador é calculada como a carga da CPU do sistema dividida pelo número de núcleos da CPU.",
                   "link_inventário": "0",
                   "vida": "0",
                   "estado": "0",
                   "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",
                   "último relógio": "0",
                   "últimos": "0",
                   "último valor": "0",
                   "valor anterior": "0",
                   "descobrir": "0",
                   "parâmetros": []
               }
           ],
           "id": 1
       }

Encontrando item dependente

Encontre um item Dependente para o item com ID "25545".

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "item.get",
           "parâmetros": {
               "saída": "estender",
               "filtro": {
                   "tipo": "18",
                   "master_itemid": "25545"
               },
               "limite": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "itemid": "25547",
                   "tipo": "18",
                   "snmp_oid": "",
                   "hostid": "10116",
                   "nome": "Segundos",
                   "key_": "apache.status.uptime.seconds",
                   "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": "",
                   "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",
                   "último relógio": "0",
                   "últimos": "0",
                   "último valor": "0",
                   "valor anterior": "0",
                   "descobrir": "0",
                   "parâmetros": []
               }
           ],
           "id": 1
       }

Localizar protótipo de item do agente HTTP

Encontre o protótipo do item do agente HTTP com o método de solicitação HEAD para ID do host.

Solicitação:

{
           "jsonrpc": "2.0",
           "método": "itemprototype.get",
           "parâmetros": {
               "hostids": "10254",
               "filtro": {
                   "tipo": "19",
                   "request_method": "3"
               }
           },
           "id": 17,
           "auth": "d678e0b85688ce578ff061bd29a20d3b"
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "itemid": "28257",
                   "tipo": "19",
                   "snmp_oid": "",
                   "hostid": "10254",
                   "nome": "descoberto",
                   "key_": "item[{#INAME}]",
                   "atraso": "{#IUPDATE}",
                   "história": "90d",
                   "tendências": "30d",
                   "estado": "0",
                   "value_type": "3",
                   "trapper_hosts": "",
                   "unidades": "",
                   "Fórmula": "",
                   "erro": "",
                   "logtimefmt": "",
                   "templateid": "28255",
                   "valuemap": "0",
                   "parâmetros": "",
                   "ipmi_sensor": "",
                   "authtype": "0",
                   "nome do usuário": "",
                   "senha": "",
                   "chave pública": "",
                   "chave privada": "",
                   "bandeiras": "2",
                   "interfaceid": "2",
                   "Descrição": "",
                   "link_inventário": "0",
                   "vida": "30d",
                   "estado": "0",
                   "evaltype": "0",
                   "jmx_endpoint": "",
                   "master_itemid": "0",
                   "tempo limite": "3s",
                   "url": "{#IURL}",
                   "query_fields": [],
                   "Postagens": "",
                   "status_codes": "",
                   "follow_redirects": "0",
                   "post_type": "0",
                   "proxy HTTP": "",
                   "cabeçalhos": [],
                   "recuperar_modo": "0",
                   "request_method": "3",
                   "output_format": "0",
                   "ssl_cert_file": "",
                   "ssl_key_file": "",
                   "ssl_key_password": "",
                   "verify_peer": "0",
                   "verify_host": "0",
                   "allow_traps": "0",
                   "descobrir": "0",
                   "parâmetros": []
               }
           ],
           "id": 17
       }

Veja também

Fonte

CItemPrototype::get() in ui/include/classes/api/services/CItemPrototype.php.