Этот раздел помогает разработчикам программного обеспечения, которые хотят разрабатывать приложения с помощью инструментов мониторинга Dotcom-Monitor.

Существует несколько способов просмотра и взаимодействия с данными мониторинга за пределами интерфейса веб-сайта Dotcom-Monitor, в том числе использование XML-канала для сбора данных и взаимодействие с API Dotcom-Monitor для мониторинга и обновления установленных агентов мониторинга.

С помощью XML-канала разработчики могут подписаться на разыскиваемые данные и представить их в своем собственном формате, используя свои собственные пользовательские отчеты. Подробнее об этом можно усмотреть с помощью инструмента службы отчетности XML (XRS).

Пользователи API Dotcom-Monitor могут создавать свои собственные пользовательские сценарии или приложения для взаимодействия с настройками и просмотра отслеживаемых данных в своей собственной настроенной среде. Наша система использует REST API, что позволяет программно взаимодействовать с веб-сайтом Dotcom-Monitor с использованием наиболее популярных методов работы с данными через HTTP(S) запросы (GET, POST, PUT, DELETE). Почти ко всем объектам Dotcom-Monitor можно получить доступ через REST API, и почти всеми аспектами функциональности службы Dotcom-Monitor можно управлять. С помощью вызовов API разработчики могут создавать и удалять устройства и задачи, откладывать и запускать их, создавать и управлять группами оповещений, шаблонами, фильтрами и планировщиками, получать информацию о состоянии устройства и многие другие опции.

В целом, API Dotcom-Monitor можно использовать в следующих задачах:

  • Сторонняя интеграция с решением Dotcom-Monitor Monitoring.
  • Загрузка и выгружа данных.
  • Изменение данных.

Наиболее распространенные действия, выполняемые через REST API:

  • Доступ к спискам платформ мониторинга, устройств, целей, планировщиков, местоположений, групп оповещений, фильтров, шаблонов оповещений.
  • Доступ к подробной информации о платформах, устройствах и целях.
  • Редактирование устройств, целевых объектов, планировщиков, групп оповещений и шаблонов, фильтров.
  • Создание нового объекта dotcom-Monitor (устройства, цели, планировщики и т.д.).
  • Управление объектами аудита.

API пользовательского коллектора

Separate MetricsView API — это набор методов для загрузки любых метрик из любого источника, независимо от платформы, в Dotcom-Monitor inc. для дальнейшей обработки и анализа.

API Dotcom-Monitor разбит на 10 типов ресурсов:

  • Платформа: Все задачи мониторинга подпадают под одну из пяти различных платформ.
  • Устройства: Мониторинг устройства является организованным «набором» задач мониторинга, который содержит либо одну задачу мониторинга, последовательность задач мониторинга, сценарий мониторинга, который включает в себя задачи, или сочетание всех трех.
  • Задачи: Задача состоит из любого действия по мониторингу, например мониторинга цели (URL, почтовый сервер, FTP Server и т.д.).
  • Частота: Определяет, как часто будут выполняться сеансы мониторинга.
  • Планировщик: Планировщик подробно, когда задача будет или не будет запущена.
  • Местонахождение: Местоположение мониторинга, доступное в сети мониторинга Dotcom-Monitor по всему миру.
  • Группа оповещения: Настройка группы помещает получателей отчета и/или оповещения в группу. Каждый получатель в группе может иметь уникальный шаблон оповещения.
  • Шаблон оповещения: Шаблон определяет формат оповещений.
  • Фильтр: Фильтр – это набор правил, определяющих, как обрабатываются и отображаются ответы мониторинга.
  • Аудит: Предоставляет историческую информацию о каждой модификации учетной записи.

Перед любым запросом API необходимо проверить подлинность в Dotcom-Monitor. Срок действия аутентификации истекает через 60 секунд после бездействия.

В таблице ниже показано, какой тип запроса и действие поддерживаются каждым типом ресурса. Подробные описания см. в разделе Методы мониторинга.

ресурса

запроса

Группа

оповещения

Тип Метод URI Описание
Платформа ПОЛУЧИТЬ /Платформ Возврат списка доступных платформ
Устройство ПОЛУЧИТЬ /приборы/{platform} Получите список устройств по платформам.
ПОЛУЧИТЬ /устройство/{deviceId} Получить информацию об устройстве
ПОМЕСТИТЬ /devices?verb=PUT Создание нового устройства
КЛАСТЬ /приборы
ПОМЕСТИТЬ /device/{deviceId}/DisableAlert/ Отключить оповещения
ПОМЕСТИТЬ /устройство/{deviceId} Редактировать устройство
ПОМЕСТИТЬ /device/{deviceId}?verb=delete Удалить устройство
УДАЛИТЬ /устройство/{deviceId}
Задача ПОЛУЧИТЬ /device/{deviceid}/tasks Получить список задач под устройством
ПОМЕСТИТЬ /tasks?verb=PUT Создать новую задачу
КЛАСТЬ /Задачи
ПОЛУЧИТЬ /задача/{TaskId} Получить информацию о задаче
ПОМЕСТИТЬ /задача/{TaskId} Редактирование задачи
ПОМЕСТИТЬ /task/{TaskId}?verb=delete Удалить задачу
УДАЛИТЬ /задача/{TaskId}
Частота Получить /frequencies/{platform_name} Получить доступ freq. по платформе.
Планировщик ПОЛУЧИТЬ /Планировщики Получить список планировщиков
ПОЛУЧИТЬ /Планировщик/{Scheduler_ID} Получение конкретной информации о планировщике
ПОМЕСТИТЬ /schedulers?verb=PUT Создание нового планировщика
КЛАСТЬ Планировщики
ПОМЕСТИТЬ /scheduler/{ идентификатор планировщика} Редактировать планировщик
ПОМЕСТИТЬ /scheduler/{Scheduler_Id}?verb=delete Удалить планировщик
УДАЛИТЬ /Планировщик/{Scheduler_Id}
Местоположение ПОЛУЧИТЬ /Местонахождения/{platform_name} Получить список доступных местоположений
оповещений ПОЛУЧИТЬ /Группы Получение списка групп оповещений
ПОМЕСТИТЬ /groups?verb=PUT/groups Создание группы оповещений
КЛАСТЬ группы/группы
ПОЛУЧИТЬ /Группа/{Group_ID} Получение информации о группе оповещений
ПОМЕСТИТЬ /Группа/{Group_ID} Изменение группы оповещений
ПОМЕСТИТЬ /Group/{Group_Id}?verb=delete Удалить группу
УДАЛИТЬ Группа/{Group_Id}
Шаблон ПОЛУЧИТЬ /Шаблоны Получить список шаблонов оповещений
ПОМЕСТИТЬ /templates?verb=PUT/templates Создание нового шаблона оповещения
КЛАСТЬ /шаблоны/шаблоны
ПОЛУЧИТЬ /шаблон/{Template_ID} Получение информации о шаблоне оповещения
ПОМЕСТИТЬ /шаблон/{Template_ID} Редактирование шаблона оповещения
ПОМЕСТИТЬ /template/{Template_Id}?verb=delete Удалить шаблон
УДАЛИТЬ /шаблон/{Template_Id}
Фильтр ПОЛУЧИТЬ /Фильтры Получить список фильтров
ПОМЕСТИТЬ /filters?verb=PUT Создать новый фильтр
КЛАСТЬ /Фильтры
ПОЛУЧИТЬ /фильтр/{filter_ID} Получение конкретной информации о фильтре
ПОМЕСТИТЬ /фильтр/{filter_ID} Редактировать фильтр
ПОМЕСТИТЬ /filter/{filter_ID}?verb=delete Удалить фильтр
УДАЛИТЬ /фильтр/{filter_ID}
Ревизия ПОЛУЧИТЬ /аудит/список Получить список проверенных объектов для текущего пользователя за последние 24 часа.
ПОЛУЧИТЬ /аудит/объект/{идентификатор образца} Получение содержимого аудита для конкретного идентификатора
ПОМЕСТИТЬ /аудит/список Получение отфильтрованного списка проверяемых объектов.