Você está visualizando a documentação da versão de desenvolvimento, que pode estar incompleta.
Esta página foi traduzida automaticamente. Se você notar um erro, selecione-o e pressione Ctrl+Enter para reportá-lo aos editores.

Objeto Task

Os seguintes objetos estão diretamente relacionados à API task.

Task

O objeto task possui as seguintes propriedades:

Propriedade Tipo Descrição
taskid ID ID da task.

Comportamento da propriedade:
- somente leitura
type integer Tipo da task.

Valores possíveis:
1 - Informações de diagnóstico;
2 - Atualizar configuração do proxy;
6 - Executar agora.

Usuários do tipo Admin e User podem criar apenas tasks do tipo 'Executar agora'.

Note que task.get sempre retorna "7" (Resumo da execução da task).

Comportamento da propriedade:
- obrigatório
status integer Status da task.

Valores possíveis:
1 - nova task;
2 - task em andamento;
3 - task concluída;
4 - task expirada.

Comportamento da propriedade:
- somente leitura
clock timestamp Hora em que a task foi criada.

Comportamento da propriedade:
- somente leitura
ttl integer Tempo em segundos após o qual a task expira.

Comportamento da propriedade:
- somente leitura
proxyid ID ID do proxy sobre o qual as estatísticas de informações de diagnóstico são coletadas.

Comportamento da propriedade:
- suportado se type estiver definido como "Informações de diagnóstico" ou "Atualizar configuração do proxy"
request object Objeto de requisição da task de acordo com o tipo da task:
O objeto da task 'Executar agora' é descrito em detalhes abaixo;
O objeto da task 'Atualizar configuração do proxy' é descrito em detalhes abaixo;
O objeto da task 'Informações de diagnóstico' é descrito em detalhes abaixo.

Comportamento da propriedade:
- obrigatório
result object Objeto de resultado da task de informações de diagnóstico.
Pode conter NULL se o resultado ainda não estiver pronto.
O objeto de resultado é descrito em detalhes abaixo.

Comportamento da propriedade:
- somente leitura

Objeto de solicitação 'Executar agora'

O objeto de solicitação da tarefa 'Executar agora' possui as seguintes propriedades.

Propriedade Tipo Descrição
itemid ID ID do item e regras de descoberta de baixo nível.

Usuários do tipo Admin e User podem 'Executar agora' itens em hosts para os quais possuem permissão de leitura-escrita permissão, ou permissão de leitura e a ação invoke_execute_now ação habilitada para sua função. O mesmo se aplica a usuários do tipo Admin para regras de descoberta de baixo nível (LLD).

Objeto de solicitação 'Atualizar configuração do proxy'

O objeto de solicitação da tarefa 'Atualizar configuração do proxy' possui as seguintes propriedades.

Propriedade Tipo Descrição
proxyids array IDs do proxy.

Objeto de solicitação de 'Informações de diagnóstico'

O objeto de solicitação de tarefa de informações de diagnóstico possui as seguintes propriedades. O objeto de solicitação de estatísticas para todos os tipos de propriedades é descrito em detalhes abaixo.

Propriedade Tipo Descrição
historycache object Solicitação de estatísticas do cache de histórico. Disponível no server e proxy.
valuecache object Solicitação de estatísticas do cache de items. Disponível no server.
preprocessing object Solicitação de estatísticas do gerenciador de pré-processamento. Disponível no server e proxy.
alerting object Solicitação de estatísticas do gerenciador de alertas. Disponível no server.
lld object Solicitação de estatísticas do gerenciador LLD. Disponível no server.
Objeto de solicitação de estatísticas

O objeto de solicitação de estatísticas é usado para definir que tipo de informação deve ser coletada sobre os processos internos do server/proxy. Ele possui as seguintes propriedades.

Propriedade Tipo Descrição
stats query Propriedades do objeto de estatísticas a serem retornadas.
A lista de campos disponíveis para cada tipo de informação de diagnóstico está descrita em detalhes abaixo.

Padrão: extend retornará todos os campos de estatísticas disponíveis.
top object Objeto para ordenar e limitar os valores de estatísticas retornados.
A lista de campos disponíveis para cada tipo de informação de diagnóstico está descrita em detalhes abaixo.

Exemplo: { “source.alerts”: 10 }
Lista de campos estatísticos disponíveis para cada tipo de solicitação de informação de diagnóstico

Os seguintes campos estatísticos podem ser solicitados para cada tipo de propriedade de solicitação de informação de diagnóstico.

Tipo de diagnóstico Campos disponíveis Descrição
historycache items Número de items em cache.
values Número de valores em cache.
memory Estatísticas de memória compartilhada (espaço livre, número de blocos usados, número de blocos livres, tamanho máximo do bloco livre).
memory.data Estatísticas de memória compartilhada do cache de dados históricos.
memory.index Estatísticas de memória compartilhada do cache de índice histórico.
valuecache items Número de items em cache.
values Número de valores em cache.
memory Estatísticas de memória compartilhada (espaço livre, número de blocos usados, número de blocos livres, tamanho máximo do bloco livre).
mode Modo do cache de valores.
preprocessing values Número de valores em fila.
preproc.values Número de valores em fila com etapas de pré-processamento.
alerting alerts Número de alertas em fila.
lld rules Número de regras em fila.
values Número de valores em fila.
Lista de campos de ordenação disponíveis para cada tipo de solicitação de informação de diagnóstico

Os seguintes campos estatísticos podem ser usados para classificar e limitar as informações solicitadas.

Tipo de diagnóstico Campos disponíveis Tipo
historycache values integer
valuecache values integer
request.values integer
preprocessing values integer
alerting media.alerts integer
source.alerts integer
lld values integer
Objeto de resultado estatístico

O objeto de resultado estatístico é recuperado no campo result do objeto de tarefa.

Propriedade Tipo Descrição
status integer Status do resultado da tarefa.

Valores possíveis:
-1 - ocorreu um erro durante a execução da tarefa;
0 - o resultado da tarefa foi criado.

Comportamento da propriedade:
- somente leitura
data string/object Resultados de acordo com o objeto de solicitação estatística de uma tarefa de informação de diagnóstico específica.
Contém a mensagem de erro como string se ocorreu um erro durante a execução da tarefa.