> Objeto de item

Os objetos a seguir estão diretamente relacionados à API item.

Item

Os itens da Web não podem ser criados, atualizados ou excluídos diretamente por meio de a API do Zabbix.

O objeto item tem as seguintes propriedades.

Propriedade Tipo Descrição
itemid string (readonly) ID do item.
atraso
(obrigatório)
string Intervalo de atualização do item. Aceita segundos ou uma unidade de tempo com sufixo (30s,1m,2h,1d).
Opcionalmente, um ou mais intervalos personalizados podem ser especificados como intervalos flexíveis ou agendamento .
Vários intervalos são separados por um ponto e vírgula.
As macros do usuário podem ser usadas. Uma única macro deve preencher todo o campo. Não há suporte para várias macros em um campo ou macros misturadas com texto.
Intervalos flexíveis podem ser escritos como duas macros separadas por uma barra (por exemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).
<br >Opcional para Zabbix trapper, itens dependentes e para Zabbix agent (ativo) com chave mqtt.get.
hostid
(obrigatório)
string ID do host ou modelo ao qual o item pertence.

Para operações de atualização, este campo é readonly.
interfaceid
(obrigatório)
string ID da interface do host do item.

Não obrigatório para itens de modelo. Opcional para itens internos, agente ativo, trapper, calculado, dependente e monitor de banco de dados.
chave_
(obrigatório)
string Chave do item.
nome
(obrigatório)
string Nome do item.
tipo
(obrigatório)
inteiro Tipo do item.

Valores possíveis:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Verificação simples;
5 - Zabbix interno;
7 - Agente Zabbix (ativo);
9 - Item da Web;
10 - Verificação externa;
11 - Monitor de banco de dados;
12 - Agente IPMI;
13 - Agente SSH;
14 - Agente Telnet;
15 - Calculado;
16 - Agente JMX;
17 - Armadilha SNMP;
18 - Item dependente ;
19 - Agente HTTP;
20 - Agente SNMP;
21 - Script
url
(obrigatório)
string string de URL, necessária apenas para o tipo de item de agente HTTP. Suporta macros de usuário, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.
valor_tipo
(obrigatório)
inteiro Tipo de informação do item.

Valores possíveis:
0 - número flutuante;
1 - caractere;<br >2 - log;
3 - numérico sem sinal;
4 - texto.
allow_traps inteiro campo de item do agente HTTP. Permitir preencher valor como no tipo de item trapper também.

0 - (padrão) Não permitir aceitar dados de entrada.
1 - Permitir aceitar dados de entrada.
authtype integer Usado apenas por itens do agente SSH ou itens do agente HTTP.

Valores possíveis do método de autenticação do agente SSH:
0 - (padrão) senha;
1 - chave pública.< br>
método de autenticação do agente HTTP valores possíveis:
0 - (padrão) nenhum
1 - básico
2 - NTLM
3 - Kerberos
descrição string Descrição do item.
error string (readonly) Texto de erro se houver problemas ao atualizar o item.
flags inteiro (somente leitura) Origem do item.

Valores possíveis:
0 - um item simples;
4 - um item descoberto.
follow_redirects inteiro campo de item do agente HTTP. Siga os redirecionamentos de resposta ao agrupar dados.

0 - Não siga os redirecionamentos.
1 - (padrão) Siga os redirecionamentos.
headers object campo de item do agente HTTP. Objeto com cabeçalhos de solicitação HTTP(S), onde o nome do cabeçalho é usado como chave e o valor do cabeçalho como valor.

Exemplo:
{ "User-Agent": "Zabbix" }
history string Uma unidade de tempo de quanto tempo os dados do histórico devem ser armazenados. Também aceita macro de usuário.

Padrão: 90d.
http_proxy string campo de item do agente HTTP. Cadeia de conexão do proxy HTTP(S).
inventário_link inteiro ID do campo de inventário do host que é preenchido pelo item.

Consulte a página de inventário do host para obter um lista de campos de inventário de host suportados e seus IDs.

Padrão: 0.
ipmi_sensor string sensor IPMI. Usado apenas por itens do IPMI.
jmx_endpoint string String de conexão personalizada do agente JMX.

Valor padrão:
service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT }/jmxrmi
lastclock timestamp (readonly) Hora em que o item foi atualizado pela última vez.

Por padrão, apenas os valores que se enquadram nas últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Período máximo de exibição do histórico na seção de menu Administração → Geral.
lastns integer (readonly) Nanossegundos quando o item foi atualizado pela última vez.

Por padrão, apenas os valores que se enquadram nas últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Período máximo de exibição do histórico na seção de menu Administração → Geral.
lastvalue string (readonly) Último valor do item.

Por padrão, apenas os valores das últimas 24 horas são exibidos. Você pode estender esse período de tempo alterando o value do parâmetro Período máximo de exibição do histórico na seção de menu Administration → General.
logtimefmt string Formato da hora nas entradas de log. Usado apenas por itens de log.
master_itemid integer ID do item mestre.
Recursão de até 3 itens dependentes e contagem máxima de itens dependentes igual a 29999 são permitidas.

Requerido por itens dependentes.
output_format inteiro campo de item do agente HTTP. A resposta deve ser convertida em JSON.

0 - (padrão) Armazenar raw.
1 - Converter em JSON.
params string Parâmetros adicionais dependendo do tipo do item:
- script executado para itens SSH e Telnet;
- consulta SQL para itens do monitor de banco de dados;
- fórmula para itens calculados;
- o script para o item de script.
parameters array Parâmetros adicionais para itens de script. Matriz de objetos com propriedades 'nome' e 'valor', onde o nome deve ser exclusivo.
senha string Senha para autenticação. Usado por itens de verificação simples, SSH, Telnet, monitor de banco de dados, JMX e agente HTTP.
Quando usado por JMX, o nome de usuário também deve ser especificado junto com a senha ou ambas as propriedades devem ser deixadas em branco.
post_type inteiro campo de item do agente HTTP. Tipo de corpo de dados de postagem armazenado na propriedade de postagens.

0 - (padrão) Dados brutos.
2 - Dados JSON.
3 - Dados XML.
posts string campo de item do agente HTTP. Dados do corpo da solicitação HTTP(S). Usado com post_type.
prevvalue string (readonly) Valor anterior do item.

Por padrão, apenas os valores das últimas 24 horas são exibidos. Você pode estender esse período alterando o valor do parâmetro Período máximo de exibição do histórico na seção de menu Administração → Geral.
privatekey string Nome do arquivo de chave privada.
publickey string Nome do arquivo de chave pública.
query_fields array campo de item do agente HTTP. Parâmetros de consulta. Matriz de objetos com pares 'chave':'valor', onde valor pode ser uma string vazia.
request_method integer campo de item do agente HTTP. Tipo de método de solicitação.

0 - (padrão) GET
1 - POST
2 - PUT
3 - HEAD
recuperar_modo inteiro campo de item do agente HTTP. Qual parte da resposta deve ser armazenada.

0 - (padrão) Corpo.
1 - Cabeçalhos.
2 - O corpo e os cabeçalhos serão armazenados.

Para request_method HEAD somente 1 é o valor permitido.
snmp_oid string SNMP OID.
ssl_cert_file string campo de item do agente HTTP. Caminho do arquivo de chave SSL pública.
ssl_key_file string campo de item do agente HTTP. Caminho do arquivo de chave SSL privada.
ssl_key_password string campo de item do agente HTTP. Senha para arquivo de chave SSL.
estado inteiro (somente leitura) Estado do item.

Valores possíveis:
0 - (padrão) normal;
1 - não suportado.
status inteiro Status do item.

Valores possíveis:
0 - (padrão) item habilitado;
1 - item desabilitado.
status_codes string campo de item do agente HTTP. Intervalos de códigos de status HTTP necessários separados por vírgulas. Também suporta macros de usuário como parte da lista separada por vírgulas.

Exemplo: 200,200-{$M},{$M},200-400
templateid string (somente leitura) ID do item de modelo pai.

Dica: Use a propriedade hostid para especificar o modelo ao qual o item pertence.
timeout string Tempo limite da solicitação de sondagem de dados do item. Usado para agente HTTP e itens de script. Suporta macros de usuário.

padrão: 3s
valor máximo: 60s
trapper_hosts string Hosts permitidos. Usado por itens de trapper ou itens de agente HTTP.
trends string Uma unidade de tempo de quanto tempo os dados de tendências devem ser armazenados. Também aceita macro de usuário.

Padrão: 365d.
unidades string Unidades de valor.
username string Username para autenticação. Usado por verificação simples, SSH, Telnet, monitor de banco de dados, itens de agente JMX e HTTP.

Requerido por itens SSH e Telnet.
Quando usado por JMX, a senha também deve ser especificada junto com o nome de usuário ou ambas as propriedades deve ser deixado em branco.
uuid string Identificador único universal, usado para vincular item importado a itens já existentes. Usado apenas para itens em modelos. Gerado automaticamente, se não fornecido.

Para operações de atualização, este campo é somente leitura.
valuemapid string ID do mapa de valores associado.
verify_host inteiro campo de item do agente HTTP. Validar o nome do host na URL está no campo Nome Comum ou em um campo Nome Alternativo da Entidade do certificado do host.

0 - (padrão) Não validar.
1 - Validar.
verify_peer integer campo de item do agente HTTP. Validar é o certificado do host autêntico.

0 - (padrão) Não validar.
1 - Validar.

Marca do item

O objeto tag do item tem as seguintes propriedades.

Propriedade Tipo Descrição
tag
(obrigatório)
string Nome da tag do item.
valor string Valor da tag do item.

Pré-processamento de itens

O objeto de pré-processamento de item tem as seguintes propriedades.

Propriedade Tipo Descrição
tipo
(obrigatório)
inteiro O tipo de opção de pré-processamento.

Valores possíveis:
1 - Multiplicador personalizado;
2 - Corte direito;
3 - Trim esquerdo;
4 - Trim;
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 - No intervalo;
14 - Corresponde à expressão regular;
15 - Não corresponde à expressão regular;
16 - Verifique se há erro no JSON;
17 - Verifique se há erro no XML;
18 - Verifique se há erro usando a expressão regular;
19 - Descarte inalterado;<br >20 - Descartar inalterado com pulsação;
21 - JavaScript;
22 - Padrão Prometheus;
23 - Prometheus para JSON;
24 - CSV para JSON;
25 - Substituir;<br >26 - Verificação não suportada;
27 - XML para JSON.
params
(obrigatório)
string Parâmetros adicionais usados pela opção de pré-processamento. Vários parâmetros são separados pelo caractere LF (\n).
error_handler
(obrigatório)
inteiro Tipo de ação usado em caso de falha na etapa de pré-processamento.

Valores possíveis:
0 - Mensagem de erro é definida pelo servidor Zabbix;< br>1 - Descartar valor;
2 - Definir valor personalizado;
3 - Definir mensagem de erro personalizada.
error_handler_params
(obrigatório)
string Parâmetros do manipulador de erros. Usado com error_handler.

Deve estar vazio, se error_handler for 0 ou 1.
Pode estar vazio se, error_handler for 2.
Não pode estar vazio, se error_handler é 3.

Os seguintes parâmetros e manipuladores de erros são suportados para cada tipo de pré-processamento.

Tipo de pré-processamento Nome Parâmetro 1 Parâmetro 2 Parâmetro 3 Manipuladores de erro suportados
1 Multiplicador personalizado número1,\6 0, 1, 2, 3
2 Corte direito lista de caracteres2
3 Corte esquerdo lista de caracteres2
4 Cortar 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 Mudança simples 0, 1, 2, 3
10 Mudança por segundo 0, 1, 2, 3
11 XML XPath caminho4 0, 1, 2, 3
12 JSONPath caminho4 0, 1, 2, 3
13 No intervalo min1,\ 6 max1,\ 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 Verifique se há erro em JSON path4 0, 1, 2, 3
17 Verificar erros em XML path4 0, 1, 2, 3
18 Verifique se há erro usando expressão regular pattern3 output2 0, 1, 2, 3
19 Descartar inalterado
20 Descartar inalterado com pulsação segundos5,\ 6
21 JavaScript script2
22 Padrão do Prometheus padrão6,\ 7 valor, rótulo, função saída8,\ 9 0, 1, 2, 3
23 Prometheus para JSON pattern6,\7 0, 1, 2, 3
24 CSV para JSON caractere2 caractere2 0,1 0, 1, 2, 3
25 Substituir sequência de pesquisa2 substituição2
26 Verificação não suportada 1, 2, 3
27 XML para JSON 0, 1, 2, 3

1 número inteiro ou de ponto flutuante
2 seqüência de caracteres
3 expressão regular
4 JSONPath ou XML XPath
5 inteiro positivo (com suporte de sufixos de tempo, por exemplo, 30s, 1m, 2h, 1d)
6 macro do usuário
7 Padrão do Prometheus seguindo a sintaxe: <nome da métrica>{<nome do rótulo>="<valor do rótulo>", ...} == <valor>. Cada Componente padrão do Prometheus (métrica, nome do rótulo, valor do rótulo e métrica value) pode ser macro do usuário.
8 Saída do Prometheus seguindo a sintaxe: <label name> (pode ser uma macro de usuário) se label for selecionado como o segundo parâmetro.
9 Uma das funções de agregação: sum, min, max, avg, count se function for selecionado como o segundo parâmetro.