Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

> objeto de relatório

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

Relatório

O objeto de relatório tem as seguintes propriedades:

Propriedade Tipo Descrição
reportid string (somente leitura) ID do relatório.
userid
(requerido)
string ID do usuário que criou o relatório.
name
(requerido)
string Nome exclusivo do relatório.
dashboardid
(requerido)
string ID do painel no qual o relatório se baseia.
period integer Período para o qual o relatório será elaborado.

Valores possíveis:
0 - (padrão) dia anterior;
1 - semana anterior;
2 - mês anterior;
3 - ano anterior.
start_time integer Hora do dia, em segundos, em que o relatório será preparado para envio.

Padrão: 0.
weekdays integer Dias da semana para envio do relatório.

Requerido apenas para relatórios semanais.

Os dias da semana são armazenados em formato binário com cada bit representando o dia da semana correspondente. Por exemplo, 12 é igual a 1100 em binário e significa que os relatórios serão enviados todas as quartas e quintas-feiras.

Padrão: 0.
active_since string Em qual data começar.

Valores possíveis:
string vazia - (padrão) não especificada (armazenada como 0);
data específica no formato AAAA-MM-DD (armazenada como timestamp do início de um dia (00:00:00)).
active_till string Em qual data terminar.

Valores possíveis:
string vazia - (padrão) não especificada (armazenada como 0);
data específica no formato AAAA-MM-DD (armazenada como carimbo de hora do fim de um dia (23:59:59)).
subject string Reportar assunto da mensagem.
message string Texto da mensagem de relatório.
status integer Se o relatório está ativado ou desativado.

Valores possíveis:
0 - Desativado;
1 - (padrão) Ativado.
description text Descrição do relatório.
state integer (somente leitura) Estado do relatório.

Valores possíveis:
0 - (padrão) o relatório ainda não foi processado;
1 - o relatório foi gerado e enviado com sucesso para todos os destinatários;
2 - falha na geração do relatório; "info" contém informações de erro;
3 - o relatório foi gerado, mas o envio para alguns (ou todos) destinatários falhou; "info" contém informações de erro.
lastsent timestamp (somente leitura) Timestamp Unix do último relatório enviado com sucesso.
info string (somente leitura) Descrição do erro ou informações adicionais.

Usuários

O objeto de usuários tem as seguintes propriedades:

Propriedade Tipo Descrição
userid
(requerido)
string ID do usuário em nome do qual o relatório será gerado.

0 - (padrão) Gerar relatório por destinatário.
exclude integer Se o usuário deve ser excluído da lista de e-mails.

Valores possíveis:
0 - (padrão) Incluir;
1 - Excluir.

Grupos de usuários

O objeto de grupos de usuários tem as seguintes propriedades:

Propriedade Tipo Descrição
usrgrpid
(requerido)
string ID do grupo de usuários para o qual enviar o relatório.
access_userid string ID do usuário em nome do qual o relatório será gerado.

0 - (padrão) Gerar relatório por destinatário.