Esta seção auxilia desenvolvedores de software que desejam desenvolver aplicativos usando ferramentas de monitoramento Dotcom-Monitor.
Existem várias maneiras de visualizar e interagir com dados de monitoramento além da interface do site do Dotcom-Monitor, incluindo o uso do feed XML para consumir dados e interagir com a API do Dotcom-Monitor para monitorar e atualizar os agentes de monitoramento instalados.
Com o feed XML, os desenvolvedores podem subscrever os dados desejados e apresentá-los em seu próprio formato usando seus próprios relatórios personalizados. Consulte Usando a ferramenta XML Reporting Service (XRS) para obter detalhes.
Os usuários de API Dotcom-Monitor podem criar seus próprios scripts ou aplicativos personalizados para interagir com as configurações e visualizar os dados monitorados em seu próprio ambiente personalizado. Nosso sistema usa a API REST que permite a interação com o site do Dotcom-Monitor programáticamente usando os métodos mais populares para trabalhar com dados através de solicitações HTTP(S) (GET, POST, PUT, DELETE). Quase todos os objetos do Dotcom-Monitor podem ser acessados via API REST e quase todos os aspectos da funcionalidade de serviço Dotcom-Monitor podem ser gerenciados. Usando chamadas de API, os desenvolvedores podem criar e remover dispositivos e tarefas, adiar e iniciá-los, criar e gerenciar grupos de alerta, modelos, filtros e agendadores, obter informações de status do dispositivo, além de muitas outras opções.
Em geral, a API Dotcom-Monitor pode ser usada nas seguintes tarefas:
- Integração de terceiros com a solução Dotcom-Monitor Monitoring.
- Download e upload de dados.
- Modificação de dados.
As ações mais comuns executadas através da API REST:
- Acessando listas de plataformas de monitoramento, dispositivos, alvos, agendadores, locais, grupos de alerta, filtros, modelos de alerta.
- Acessando informações detalhadas em plataformas, dispositivos e alvos.
- Editando dispositivos, alvos, agendadores, grupos de alerta e modelos, filtros.
- Criando um novo objeto dotcom-Monitor (dispositivos, alvos, agendadores, etc.).
- Gerenciamento de objetos de auditoria.
A API do Dotcom-Monitor é dividida em 10 tipos de recursos:
- Plataforma: Todas as tarefas de monitoramento caem em uma das cinco plataformas diferentes.
- Dispositivos: Um dispositivo monitorado é um “conjunto” organizado de tarefas de monitoramento que contém uma única tarefa de monitoramento, uma sequência de tarefas de monitoramento, um script de monitoramento que inclui tarefas ou uma combinação de todas as três.
- Tarefas: Uma tarefa é qualquer atividade de monitoramento único, como monitorar um alvo (URL, Mail Server, FTP Server, etc.).
- Frequência: Define com que frequência as sessões de monitoramento serão executadas.
- Agendador: Um agendador detalha quando uma tarefa será ou não executada.
- Localização: Um local de monitoramento disponível dentro da rede mundial de monitoramento Dotcom-Monitor.
- Grupo de Alerta: A criação de um grupo coloca os destinatários de um relatório e/ou alerta em um grupo. Cada destinatário do grupo pode ter um modelo de alerta exclusivo.
- Modelo de alerta: O modelo define o formato de alertas.
- Filtro: Um filtro é um conjunto de regras, que determinam como as respostas de monitoramento são processadas e exibidas.
- Auditoria: Fornece informações históricas sobre qualquer modificação de conta.
A tabela abaixo mostra qual tipo de solicitação e ação são suportadas por cada tipo de recurso. Consulte a seção Métodos de Monitoramento para obter descrições detalhadas.
Tipo de recurso | Método | URI(s) | Descrição |
---|---|---|---|
Plataforma | OBTER | /Plataformas | Retornar lista de plataformas disponíveis |
Dispositivo | OBTER | /Dispositivos/{platform} | Obtenha a lista de dispositivos por plataforma. |
OBTER | /dispositivo/{deviceId} | Obter informações do dispositivo | |
POSTAR | /devices?verb=PUT | Criar novo dispositivo | |
PÔR | /Dispositivos | ||
POSTAR | /device/{deviceId}/DisableAlert/ | Desativar alertas | |
POSTAR | /dispositivo/{deviceId} | Editar dispositivo | |
POSTAR | /device/{deviceId}?verb=delete | Excluir dispositivo | |
EXCLUIR | /dispositivo/{deviceId} | ||
Tarefa | OBTER | /device/{deviceid}/tasks | Obter lista de tarefas em um dispositivo |
POSTAR | /tasks?verb=PUT | Criar nova tarefa | |
PÔR | /Tarefas | ||
OBTER | /tarefa/{TaskId} | Obter informações da tarefa | |
POSTAR | /tarefa/{TaskId} | Tarefa de edição | |
POSTAR | /task/{TaskId}?verb=delete | Excluir tarefa | |
EXCLUIR | /tarefa/{TaskId} | ||
frequência | Obter | /frequencies/{platform_name} | Fique disponível freq. por plataforma. |
Agendador | OBTER | /Agendadores | Obter lista de agendadores |
OBTER | /Agendador/{Scheduler_ID} | Obter informações específicas do agendador | |
POSTAR | /schedulers?verb=PUT | Criar novo agendador | |
PÔR | Agendadores | ||
POSTAR | /scheduler/{ ID do agendador} | Editar agendador | |
POSTAR | /Scheduler/{Scheduler_Id}?verb=delete | Excluir agendador | |
EXCLUIR | /Agendador/{Scheduler_Id} | ||
Localização | OBTER | /Locais/{platform_name} | Obter lista de locais disponíveis |
Grupo | OBTER | /Grupos | Obter lista de grupos de alertas |
POSTAR | /groups?verb=PUT/groups | Criar grupo de alertas | |
PÔR | grupos/grupos | ||
OBTER | /Grupo/{Group_ID} | Obter informações do grupo de alertas | |
POSTAR | /Grupo/{Group_ID} | Editar grupo de alertas | |
POSTAR | /Group/{Group_Id}?verb=delete | Excluir grupo | |
EXCLUIR | Grupo/{Group_Id} | ||
Modelo de | OBTER | /Modelos | Obter lista de modelos de alerta |
POSTAR | /templates?verb=PUT/templates | Criar novo modelo de alerta | |
PÔR | /modelos/modelos | ||
OBTER | /modelo/{Template_ID} | Obter informações do modelo de alerta | |
POSTAR | /modelo/{Template_ID} | Editar modelo de alerta | |
POSTAR | /template/{Template_Id}?verb=delete | Excluir modelo | |
EXCLUIR | /modelo/{Template_Id} | ||
Filtro | OBTER | /Filtros | Obter lista de filtros |
POSTAR | /filtros?verbo=PUT | Criar novo filtro | |
PÔR | /Filtros | ||
OBTER | /filtro/{filter_ID} | Obter informações específicas sobre filtros | |
POSTAR | /filtro/{filter_ID} | Editar filtro | |
POSTAR | /filter/{filter_ID}?verb=delete | Excluir filtro | |
EXCLUIR | /filtro/{filter_ID} | ||
Auditoria | OBTER | /auditoria/lista | Obtenha objetos auditados da lista para o usuário atual nas últimas 24 horas. |
OBTER | /audit/object/{sample ID} | Obter o conteúdo da auditoria para o ID específico | |
POSTAR | /auditoria/lista | Obtenha uma lista filtrada de objetos auditados. |