Nesta página
Objeto item
Os seguintes objetos estão diretamente relacionados à API de item.
Item
Os itens web não podem ser criados, atualizados ou excluídos diretamente por meio da API do Zabbix.
O objeto item tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| itemid | ID | ID do item. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| delay | string | Intervalo de atualização do item. Aceita um número de segundos (por exemplo, 1, 60, 300), um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h, 1d) ou, opcionalmente, um ou mais intervalos personalizados, todos separados por ponto e vírgula. Os intervalos personalizados podem ser uma combinação de intervalos flexíveis e de agendamento.Aceita macros de usuário. Se usada, o valor deve ser uma única macro. Não há suporte para várias macros ou macros combinadas com texto. Os intervalos flexíveis podem ser escritos como duas macros separadas por uma barra (por exemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Exemplo: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Comportamento da propriedade: - obrigatório se type estiver definido como "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), "Telemetry query" (24), ou se type estiver definido como "Zabbix agent (active)" (7) e key_ não contiver "mqtt.get" |
| hostid | ID | ID do host ou template ao qual o item pertence. Comportamento da propriedade: - constante - obrigatório para operações de criação |
| interfaceid | ID | ID da interface do host do item. Comportamento da propriedade: - obrigatório se o item pertencer a um host e type estiver definido como "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" ou "SNMP agent"- com suporte se o item pertencer a um host e type estiver definido como "Simple check", "External check", "SSH agent", "TELNET agent" ou "HTTP agent"- somente leitura para objetos descobertos |
| key_ | string | Chave do item. Comportamento da propriedade: - obrigatória para operações de criação - somente leitura para objetos herdados ou descobertos |
| name | string | Nome do item. Oferece suporte a macros de usuário. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados ou descobertos |
| name_resolved | string | Nome do item com as macros de usuário resolvidas. Comportamento da propriedade: - somente leitura |
| type | integer | Tipo do item. Valores possíveis: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 9 - Web item; 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser; 24 - Telemetry query. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados ou descobertos |
| url | string | String de URL. Oferece suporte a macros de usuário, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Comportamento da propriedade: - obrigatório se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| value_type | integer | Tipo de informação do item. Valores possíveis: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary; 6 - JSON. Comportamento da propriedade: - obrigatório para operações de criação - somente leitura para objetos herdados ou descobertos |
| allow_traps | integer | Permite preencher o valor de forma semelhante ao item trapper. 0 - (padrão) Não permitir aceitar dados recebidos; 1 - Permitir aceitar dados recebidos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos descobertos |
| authtype | integer | Método de autenticação. Valores possíveis se type estiver definido como "SSH agent":0 - (padrão) senha; 1 - chave pública. Valores possíveis se type estiver definido como "HTTP agent":0 - (padrão) nenhum; 1 - básico; 2 - NTLM; 3 - Kerberos; 4 - Digest. Comportamento da propriedade: - com suporte se type estiver definido como "SSH agent" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") ou objetos descobertos |
| description | string | Descrição do item. Comportamento da propriedade: - somente leitura para objetos descobertos |
| error | string | Texto do erro caso haja problemas ao atualizar o valor do item. Comportamento da propriedade: - somente leitura |
| flags | integer | Origem do item. Valores possíveis: 0 - um item comum; 4 - um item convertido de um protótipo. Comportamento da propriedade: - somente leitura |
| follow_redirects | integer | Seguir redirecionamentos da resposta durante a coleta de dados. Valores possíveis: 0 - Não seguir redirecionamentos; 1 - (padrão) Seguir redirecionamentos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| headers | array | Matriz de cabeçalhos que será enviada ao executar uma solicitação HTTP. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| history | string | Unidade de tempo durante a qual os dados de histórico devem ser armazenados. Também aceita macro de usuário. Padrão: 31d. Comportamento da propriedade: - somente leitura para objetos descobertos |
| http_proxy | string | String de conexão do proxy HTTP(S). Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| inventory_link | integer | ID do campo de inventário do host preenchido pelo item. Consulte a página de inventário do host para obter uma lista dos campos de inventário do host compatíveis e seus IDs. Padrão: 0. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float", "character", "numeric unsigned" ou "text"- somente leitura para objetos descobertos |
| ipmi_sensor | string | Sensor IPMI. Comportamento da propriedade: - obrigatório se type estiver definido como "IPMI agent" e key_ não estiver definido como "ipmi.get"- com suporte se type estiver definido como "IPMI agent"- somente leitura para objetos herdados ou descobertos |
| jmx_endpoint | string | String de conexão personalizada do JMX agent. Valor padrão: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamento da propriedade: - com suporte se type estiver definido como "JMX agent"- somente leitura para objetos descobertos |
| lastclock | timestamp | Momento em que o valor do item foi atualizado pela última vez. Por padrão, somente os valores das últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Max history display period na seção de menu Administration > General. Comportamento da propriedade: - somente leitura |
| lastns | integer | Nanossegundos do momento em que o valor do item foi atualizado pela última vez. Por padrão, somente os valores das últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Max history display period na seção de menu Administration > General. Comportamento da propriedade: - somente leitura |
| lastvalue | string | Último valor do item. Por padrão, somente os valores das últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Max history display period na seção de menu Administration > General. Comportamento da propriedade: - somente leitura |
| logtimefmt | string | Formato da hora nas entradas de log. Comportamento da propriedade: - com suporte se value_type estiver definido como "log"- somente leitura para objetos herdados ou descobertos |
| master_itemid | ID | ID do item mestre. Comportamento da propriedade: - obrigatório se type estiver definido como "Dependent item"- somente leitura para objetos herdados ou descobertos |
| output_format | integer | Define se a resposta deve ser convertida para JSON. 0 - (padrão) Armazenar como bruta; 1 - Converter para JSON. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| params | string | Parâmetros adicionais dependendo do tipo do item: - script executado para itens SSH agent e TELNET agent; - consulta SQL para itens Database monitor; - fórmula para itens Calculated; - script para itens Script e Browser. Comportamento da propriedade: - obrigatório se type estiver definido como "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" ou "Browser"- somente leitura para objetos herdados (se type estiver definido como "Script" ou "Browser") ou objetos descobertos |
| parameters | object/array | Parâmetros adicionais se type estiver definido como "Script" ou "Browser". Matriz de objetos com as propriedades name e value, em que name deve ser exclusivo.Comportamento da propriedade: - com suporte se type estiver definido como "Script" ou "Browser"- somente leitura para objetos herdados ou descobertos |
| password | string | Senha para autenticação. Comportamento da propriedade: - obrigatória se type estiver definido como "JMX agent" e username estiver definido- com suporte se type estiver definido como "Simple check", "SSH agent", "TELNET agent", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") ou objetos descobertos |
| post_type | integer | Tipo do corpo dos dados de postagem armazenado na propriedade posts.Valores possíveis: 0 - (padrão) Dados brutos; 2 - Dados JSON; 3 - Dados XML. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| posts | string | Dados do corpo da solicitação HTTP(S). Comportamento da propriedade: - obrigatório se type estiver definido como "HTTP agent" e post_type estiver definido como "JSON data" ou "XML data"- com suporte se type estiver definido como "HTTP agent" e post_type estiver definido como "Raw data"- somente leitura para objetos herdados ou descobertos |
| prevvalue | string | Valor anterior do item. Por padrão, somente os valores das últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Max history display period na seção de menu Administration > General. Comportamento da propriedade: - somente leitura |
| privatekey | string | Nome do arquivo de chave privada. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent" e authtype estiver definido como "public key"- somente leitura para objetos descobertos |
| publickey | string | Nome do arquivo de chave pública. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent" e authtype estiver definido como "public key"- somente leitura para objetos descobertos |
| query_fields | array | Matriz de campos de consulta que será enviada ao executar uma solicitação HTTP. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| request_method | integer | Tipo do método de solicitação. Valores possíveis: 0 - (padrão) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| retrieve_mode | integer | Parte da resposta que deve ser armazenada. Valores possíveis se request_method estiver definido como "GET", "POST" ou "PUT":0 - (padrão) Corpo; 1 - Cabeçalhos; 2 - O corpo e os cabeçalhos serão armazenados. Valores possíveis se request_method estiver definido como "HEAD":1 - Cabeçalhos. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| snmp_oid | string | OID SNMP. Comportamento da propriedade: - obrigatório se type estiver definido como "SNMP agent"- somente leitura para objetos herdados ou descobertos |
| ssl_cert_file | string | Caminho do arquivo da chave SSL pública. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| ssl_key_file | string | Caminho do arquivo da chave SSL privada. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| ssl_key_password | string | Senha do arquivo de chave SSL. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| state | integer | Estado do item. Valores possíveis: 0 - (padrão) normal; 1 - sem suporte. Comportamento da propriedade: - somente leitura |
| status | integer | Status do item. Valores possíveis: 0 - (padrão) item habilitado; 1 - item desabilitado. |
| status_codes | string | Intervalos dos códigos de status HTTP necessários, separados por vírgulas. Também oferece suporte a macros de usuário como parte da lista separada por vírgulas. Exemplo: 200,200-{$M},{$M},200-400 Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| templateid | ID | ID do item do template pai. Dica: use a propriedade hostid para especificar o template ao qual o item pertence.Comportamento da propriedade: - somente leitura |
| timeout | string | Tempo limite da solicitação de coleta de dados do item. Aceita um número de segundos (por exemplo, 1, 60, 300) ou um valor com um sufixo de tempo (por exemplo, 300s, 1m). Também aceita macros de usuário.O intervalo de valores possíveis é: 1-600s. Padrão: "" - usar as configurações do proxy/globais. Comportamento da propriedade: - com suporte se type estiver definido como "Zabbix agent" (0), "Simple check" (3) e key_ não começar com "vmware." e "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) e snmp_oid começar com "walk[" ou "get[", "Script" (21), "Browser" (22)- somente leitura para objetos herdados e descobertos, - se o valor padrão for aplicado e o item pertencer a um host monitorado por um proxy ou grupo de proxies inacessível, o tempo limite global será usado. |
| trapper_hosts | string | Hosts permitidos. Comportamento da propriedade: - somente leitura para objetos descobertos - com suporte se type estiver definido como "Zabbix trapper", ou se type estiver definido como "HTTP agent" e allow_traps estiver definido como "Allow to accept incoming data".Se a propriedade for omitida, ela será definida automaticamente como a macro de usuário {$TRAPPER.ALLOWED_HOSTS} (valor padrão). Por padrão, {$TRAPPER.ALLOWED_HOSTS} é 127.0.0.1,::1.Se a propriedade for definida como uma string vazia, as conexões recebidas serão negadas de todos os hosts. |
| trends | string | Unidade de tempo durante a qual os dados de tendências devem ser armazenados. Também aceita macro de usuário. Padrão: 365d. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float" ou "numeric unsigned"- somente leitura para objetos descobertos |
| units | string | Unidades do valor. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float" ou "numeric unsigned"- somente leitura para objetos herdados ou descobertos |
| username | string | Nome de usuário para autenticação. Comportamento da propriedade: - obrigatório se type estiver definido como "SSH agent", "TELNET agent", ou se type estiver definido como "JMX agent" e password estiver definido- com suporte se type estiver definido como "Simple check", "Database monitor" ou "HTTP agent"- somente leitura para objetos herdados (se type estiver definido como "HTTP agent") ou objetos descobertos |
| uuid | string | Identificador universal exclusivo, usado para vincular o item importado aos itens já existentes. Gerado automaticamente se não for fornecido. Comportamento da propriedade: - com suporte se o item pertencer a um template |
| valuemapid | ID | ID do mapa de valores associado. Comportamento da propriedade: - com suporte se value_type estiver definido como "numeric float", "character" ou "numeric unsigned"- somente leitura para objetos herdados ou descobertos |
| verify_host | integer | Define se deve ser validado que o nome do host da conexão corresponde ao nome no certificado do host. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| verify_peer | integer | Define se deve ser validado que o certificado do host é autêntico. Valores possíveis: 0 - (padrão) Não validar; 1 - Validar. Comportamento da propriedade: - com suporte se type estiver definido como "HTTP agent"- somente leitura para objetos herdados ou descobertos |
| query | object | Configuração da consulta de telemetria. Define o que o item consulta na fonte de dados de telemetria, como filtra os dados e como agrega o resultado. Comportamento da propriedade: - obrigatório se type estiver definido como "Telemetry query"- somente leitura para objetos herdados ou descobertos |
| time_shift | string | Quanto para trás, antes do momento atual, termina o intervalo de tempo consultado pelo item. Aceita um número de segundos (por exemplo, 1, 60, 300) ou um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h, 1d). Também aceita macros de usuário.O intervalo de valores possíveis é: 0-86400s. Padrão: 15s. Comportamento da propriedade: - com suporte se type estiver definido como "Telemetry query" |
| lookback_limit | string | Quanto para trás, antes do momento atual, o item consulta dados quando não há uma consulta anterior da qual continuar (por exemplo, na primeira execução do item), ou quando a consulta anterior é mais antiga que delay (por exemplo, porque o Zabbix server estava inativo).Aceita um número de segundos (por exemplo, 1, 60, 300) ou um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h, 1d). Também aceita macros de usuário.O intervalo de valores possíveis é: 1-259200s. Padrão: 10m. Comportamento da propriedade: - com suporte se type estiver definido como "Telemetry query" |
| granularity | string | Duração de cada parte em que o intervalo de tempo completo da consulta é dividido. Aceita um número de segundos (por exemplo, 1, 60, 300) ou um valor com um sufixo de tempo (por exemplo, 30s, 1m, 2h, 1d). Também aceita macros de usuário.O intervalo de valores possíveis é: 1-86400s. Padrão: 15s. Comportamento da propriedade: - com suporte se type estiver definido como "Telemetry query" |
Cabeçalho HTTP
O objeto header possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do cabeçalho HTTP. Comportamento da propriedade: - obrigatório |
| value | string | Valor do cabeçalho. Comportamento da propriedade: - obrigatório |
Campo de consulta HTTP
O objeto de campo de consulta define um nome e valor que é usado para especificar um parâmetro de URL. Ele possui as seguintes propriedades:
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome do parâmetro. Comportamento da propriedade: - obrigatório |
| value | string | Valor do parâmetro. Comportamento da propriedade: - obrigatório |
Consulta de telemetria
O objeto de consulta de telemetria tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| signal_type | integer | Tipo de sinal consultado pelo item. Valores possíveis: 0 - Traces; 1 - Métricas; 2 - Logs. Comportamento da propriedade: - obrigatório |
| metric_point_type | integer | Tipo de ponto de métrica consultado pelo item. Valores possíveis: 0 - Soma; 1 - Gauge; 2 - Histograma; 3 - Histograma exponencial. Comportamento da propriedade: - obrigatório se signal_type estiver definido como "Metrics" |
| columns | array | Array de colunas de dados de telemetria consultadas pelo item. Pode estar vazio. Comportamento da propriedade: - obrigatório |
| aggregated_columns | array | Array de colunas agregadas de dados de telemetria consultadas pelo item e de como ele calcula um valor a partir dos registros das colunas. Comportamento da propriedade: - obrigatório |
| filter | object | Filtro de consulta de telemetria para os registros de colunas na consulta. Comportamento da propriedade: - obrigatório |
Colunas de dados de telemetria
O objeto de colunas de dados de telemetria tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| column | string | Nome da coluna de dados de telemetria consultada pelo item. Consulte colunas de dados de telemetria compatíveis. Para várias colunas de valor único, cada valor de column deve ser exclusivo. Para várias colunas que contêm pares de chave-valor, cada par de valores column e attribute_key deve ser exclusivo. |
| attribute_key | string | Nome da chave consultada pelo item na coluna que contém pares de chave-valor. Para várias colunas que contêm pares de chave-valor, cada par de valores column e attribute_key deve ser exclusivo.Comportamento da propriedade: - obrigatório se column estiver definido como uma coluna que contém pares de chave-valor |
Colunas agregadas de dados de telemetria
O objeto de colunas agregadas de dados de telemetria tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| column | string | Nome da coluna de dados de telemetria consultada pelo item. Consulte colunas de dados de telemetria compatíveis. Para várias colunas, cada valor de column deve ser exclusivo.Esta propriedade não é compatível quando function está definido como "Count".Comportamento da propriedade: - obrigatória se function estiver definido como "Min", "Max", "Average", "Sum" ou "Percentile" |
| function | integer | Função que o item aplica aos registros da coluna. Valores possíveis: 1 - Min; 2 - Max; 3 - Average; 4 - Count; 5 - Sum; 8 - Percentile. Comportamento da propriedade: - obrigatória |
| parameters | array | Percentil que o item calcula a partir dos registros da coluna. Valor possível: um número de 0 a 100, fornecido como uma string. Comportamento da propriedade: - obrigatória se function estiver definido como "Percentile" |
| alias | string | Nome exclusivo do valor calculado, usado para identificá-lo no valor do item. Cada valor de alias deve ser exclusivo.Comportamento da propriedade: - obrigatória |
Filtro de dados de telemetria
O objeto de filtro de dados de telemetria tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| conditions | array | Condições do filtro de dados de telemetria que um registro em uma coluna de dados de telemetria deve atender. Comportamento da propriedade: - obrigatório |
| evaltype | integer | Método de avaliação das condições do filtro. Valores possíveis: 0 - And/Or; 1 - And; 2 - Or; 3 - Expressão personalizada. Comportamento da propriedade: - obrigatório |
| eval_formula | string | Expressão gerada que será usada para avaliar as condições do filtro. A expressão contém IDs que fazem referência a condições específicas do filtro por meio de formulaid. O valor de eval_formula é igual ao valor de formula para filtros com uma expressão personalizada.Comportamento da propriedade: - somente leitura |
| formula | string | Expressão definida pelo usuário a ser usada para avaliar as condições de filtros com uma expressão personalizada. A expressão deve conter IDs que façam referência a condições específicas do filtro por meio de formulaid. Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro: nenhuma condição pode permanecer sem uso ou ser omitida.Comportamento da propriedade: - obrigatório se evaltype estiver definido como "Expressão personalizada" |
Condições de filtro de dados de telemetria
O objeto de condições de filtro de dados de telemetria tem as seguintes propriedades.
| Property | Type | Description |
|---|---|---|
| column | string | Nome da coluna de dados de telemetria à qual a condição de filtro se aplica. Consulte colunas de dados de telemetria compatíveis. Comportamento da propriedade: - obrigatório |
| attribute_key | string | Nome da chave à qual a condição se aplica, dentro da coluna que contém pares de chave-valor. Comportamento da propriedade: - obrigatório se column estiver definida como uma coluna que contém pares de chave-valor |
| operator | integer | Operador da condição de filtro. Valores possíveis para colunas de valor único: 0 - É igual a; 1 - Não é igual a; 2 - Contém; 3 - Não contém. Valores possíveis para colunas que contêm pares de chave-valor: 0 - É igual a; 1 - Não é igual a; 12 - Existe. Comportamento da propriedade: - obrigatório |
| value | string | Valor a ser comparado. Comportamento da propriedade: - obrigatório se operator estiver definido como "É igual a", "Não é igual a", "Contém" ou "Não contém" |
| formulaid | string | ID exclusivo arbitrário usado para referenciar a condição em uma expressão personalizada. Pode conter apenas letras maiúsculas. O ID deve ser definido pelo usuário ao modificar as condições de filtro, mas será gerado novamente ao solicitá-las posteriormente. Comportamento da propriedade: - obrigatório se evaltype do objeto Filtro de consulta de telemetria estiver definido como "Expressão personalizada" |
Tag de item
O objeto de tag de item possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| tag | string | Nome da tag do item. Comportamento da propriedade: - obrigatório |
| value | string | Valor da tag do item. Comportamento da propriedade: - somente leitura. |
| object | integer | Tipo de objeto do qual a tag foi herdada. Valores possíveis: 0 - template; 1 - host. Comportamento da propriedade: - somente leitura. |
| objectid | ID | ID do objeto do qual a tag foi herdada. Comportamento da propriedade: - somente leitura. |
Pré-processamento de item
O objeto de pré-processamento de item tem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | O tipo de opção de pré-processamento. Valores possíveis: 1 - Multiplicador personalizado; 2 - Remover espaços à direita; 3 - Remover espaços à esquerda; 4 - Remover espaços; 5 - 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 - XPath XML; 12 - JSONPath; 13 - No intervalo; 14 - Corresponde à expressão regular; 15 - Não corresponde à expressão regular; 16 - Verificar erro em JSON; 17 - Verificar erro em XML; 18 - Verificar erro usando expressão regular; 19 - Descartar se inalterado; 20 - Descartar se inalterado com heartbeat; 21 - JavaScript; 22 - Padrão do Prometheus; 23 - Prometheus para JSON; 24 - CSV para JSON; 25 - Substituir; 26 - Verificar não suportado; 27 - XML para JSON; 28 - Valor de SNMP walk; 29 - SNMP walk para JSON; 30 - Valor de SNMP get. Comportamento da propriedade: - obrigatória |
| params | string | Parâmetros adicionais usados pela opção de pré-processamento. Vários parâmetros são separados pelo caractere de nova linha (\n). Se type estiver definido como "Verificar não suportado", os parâmetros seguem a sintaxe <scope>[\n<pattern>], em que pattern é uma expressão regular e scope é um dos seguintes:-1 - corresponde a qualquer erro; \ 0 - verifica se a mensagem de erro corresponde a pattern; \ 1 - verifica se a mensagem de erro não corresponde a pattern. Comportamento da propriedade: - obrigatória se type estiver definido como "Multiplicador personalizado" (1), "Remover espaços à direita" (2), "Remover espaços à esquerda" (3), "Remover espaços" (4), "Expressão regular" (5), "XPath XML" (11), "JSONPath" (12), "No intervalo" (13), "Corresponde à expressão regular" (14), "Não corresponde à expressão regular" (15), "Verificar erro em JSON" (16), "Verificar erro em XML" (17), "Verificar erro usando expressão regular" (18), "Descartar se inalterado com heartbeat" (20), "JavaScript" (21), "Padrão do Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Substituir" (25), Verificar não suportado (26), "Valor de SNMP walk" (28), "SNMP walk para JSON" (29) ou "Valor de SNMP get" (30) |
| error_handler | integer | Tipo de ação usado em caso de falha da etapa de pré-processamento. Valores possíveis: 0 - A mensagem de erro é definida pelo Zabbix server; 1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. Valores possíveis se type estiver definido como "Verificar não suportado":1 - Descartar valor; 2 - Definir valor personalizado; 3 - Definir mensagem de erro personalizada. Comportamento da propriedade: - obrigatória se type estiver definido como "Multiplicador personalizado" (1), "Expressão regular" (5), "Booleano para decimal" (6), "Octal para decimal" (7), "Hexadecimal para decimal" (8), "Alteração simples" (9), "Alteração por segundo" (10), "XPath XML" (11), "JSONPath" (12), "No intervalo" (13), "Corresponde à expressão regular" (14), "Não corresponde à expressão regular" (15), "Verificar erro em JSON" (16), "Verificar erro em XML" (17), "Verificar erro usando expressão regular" (18), "Padrão do Prometheus" (22), "Prometheus para JSON" (23), "CSV para JSON" (24), "Verificar não suportado" (26), "XML para JSON" (27), "Valor de SNMP walk" (28), "SNMP walk para JSON" (29) ou "Valor de SNMP get" (30) |
| error_handler_params | string | Parâmetros do manipulador de erros. Comportamento da propriedade: - obrigatória se error_handler estiver definido como "Definir valor personalizado" ou "Definir mensagem de erro personalizada" |
Os seguintes parâmetros e manipuladores de erros são compatíveis com cada tipo de pré-processamento.
| Tipo de pré-processamento | Nome | Parâmetro 1 | Parâmetro 2 | Parâmetro 3 | Manipuladores de erros compatíveis |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | número1, 6 | 0, 1, 2, 3 | ||
| 2 | Remover espaços à direita | lista de caracteres2 | |||
| 3 | Remover espaços à esquerda | lista de caracteres2 | |||
| 4 | Remover espaços | lista de caracteres2 | |||
| 5 | Expressão regular | padrão3 | saída2 | 0, 1, 2, 3 | |
| 6 | Booleano para decimal | 0, 1, 2, 3 | |||
| 7 | Octal para decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal para decimal | 0, 1, 2, 3 | |||
| 9 | Alteração simples | 0, 1, 2, 3 | |||
| 10 | Alteração por segundo | 0, 1, 2, 3 | |||
| 11 | XPath XML | caminho4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | caminho4 | 0, 1, 2, 3 | ||
| 13 | No intervalo | mín.1, 6 | máx.1, 6 | 0, 1, 2, 3 | |
| 14 | Corresponde à expressão regular | padrão3 | 0, 1, 2, 3 | ||
| 15 | Não corresponde à expressão regular | padrão3 | 0, 1, 2, 3 | ||
| 16 | Verificar erro em JSON | caminho4 | 0, 1, 2, 3 | ||
| 17 | Verificar erro em XML | caminho4 | 0, 1, 2, 3 | ||
| 18 | Verificar erro usando expressão regular | padrão3 | saída2 | 0, 1, 2, 3 | |
| 19 | Descartar se inalterado | ||||
| 20 | Descartar se inalterado com heartbeat | segundos5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Padrão do Prometheus | padrão6, 7 | value, label, function |
saída8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus para JSON | padrão6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV para JSON | caractere2 | caractere2 | 0,1 | 0, 1, 2, 3 |
| 25 | Substituir | string de pesquisa2 | substituição2 | ||
| 26 | Verificar não suportado | escopo1 | padrão3, 6 | 1, 2, 3 | |
| 27 | XML para JSON | 0, 1, 2, 3 | |||
| 28 | Valor de SNMP walk | OID2 | Formato: 0 - Inalterado 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk para JSON10 | Nome do campo2 | Prefixo do OID2 | Formato: 0 - Inalterado 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 |
| 30 | Valor de SNMP get | Formato: 1 - UTF-8 de Hex-STRING 2 - MAC de Hex-STRING 3 - Inteiro de BITS |
0, 1, 2, 3 | ||
1 número de ponto flutuante (os inteiros são convertidos implicitamente em valores de ponto flutuante)
2 string
3 expressão regular
4 JSONPath ou XPath XML
5 inteiro positivo (com suporte a sufixos de tempo, por exemplo, 30s, 1m, 2h, 1d)
6 macro de usuário
7 padrão do Prometheus seguindo a sintaxe: <metric name>{<label name>="<label value>", ...} == <value>.
Cada componente do padrão do Prometheus (métrica, nome do label, valor do label e valor da métrica) pode ser uma macro de usuário.
8 saída do Prometheus seguindo a sintaxe: <label name> (pode ser uma macro de usuário) se label estiver selecionado como segundo parâmetro.
9 Uma das funções de agregação: sum, min, max, avg, count se function estiver selecionado como segundo parâmetro.
10 Compatível com vários registros "Nome do campo,Prefixo do OID,Formato", delimitados por um caractere de nova linha.