Как известно, API, Application Programming Interface (программный интерфейс приложения) – набор методов, классов, функций, библиотек и т.д., которые обеспечивают взаимодействие между компьютерными программами. Использование API упрощает управление и автоматизацию процессов в обычно многоуровневой иерархии компонентов программ.

«Центральный пульт» обладает собственным API, относящимся к классу REpresentational State Transfer (REST), что дает возможность выполнять RESTful-операции по чтению, добавлению, изменению и удалению информации об объектах системы мониторинга.

С помощью REST API реализуются следующие действия:

• получение списка объектов;
  
• получение иерархической структуры объектов;
  
• получение текущего статуса объектов и истории их состояний;
  
• запись данных в объекты без использования агентов;
  
• настройка свойств объектов;
  
• получение свойств объектов;
  
• получение параметров объектов;
  
• работа с инцидентами;
  
• cоздание классов с добавлением проверок.
  
  

В ходе мастер-класса были использованы примеры из документации по работе с API «Центрального Пульта», которая свободно доступна на официальном сайте wiki.saymon.info.

Во-первых, можно установить специальный инструмент для работы с API – Postman и с помощью него совершать запросы. Во-вторых, можно использовать Bash, Python или любой другой язык программирования, который позволяет выполнять HTTP- и HTTPS-запросы.

В документации по системе переходим в раздел «Объекты», в котором доступны примеры запросов и ответов от сервера на языках Bash, JavaScript, NodeJS и Python.

Для обращения к API необходимы логин (login) и пароль (password), доступные в настройках «Центрального Пульта» (см. пример 1). В параметре "parent_id" указывается идентификатор родительского объекта, в котором необходимо создать новый объект (в примере – 1).

В программном комплексе «Центральный Пульт» все объекты принадлежат к какому-либо классу, что способствует удобству кастомизации и автоматизации. В параметре "class_id" указывается идентификатор класса объекта, например, 24 соответствует классу INFO. С классами объектов можно подробнее ознакомиться в разделе «Конфигурации» документации.

Добавить операцию для объекта можно с помощью небольшого скрипта в окне настройки операции веб-интерфейса. Подробнее о работе в интерфейсе «Центрального Пульта» Денис рассказывал на мастер-классе, прошедшем 27 января.

Ниже приведен исходный код одного из скриптов, с помощью которого была продемонстрирована работа с операциями на объектах.

Скрытие своих логина и пароля осуществляется путем запроса токена авторизации через API с помощью скрипта из примера 3.

«Протухание данных» ("expiry period") – это период времени, в течение которого полученные данные актуальны. Если установить для объекта тип проверки «не проверять», то данные «протухнут», а объект перейдет в состояние "disabled". Чтобы избежать этого, можно использовать тип проверки «Внешняя проверка».

Период «протухания» можно установить при помощи REST-метода на любой промежуток времени – от суток до десятков лет. Режим прекращения валидности данных используется для отслеживания ситуации, при которой данные перестают поступать с объекта мониторинга (через оповещения системы, автоматизированные средства запуска скриптов, уведомлений и т.д.).

Такой сценарий актуален для компаний в случаях, когда отдельные команды не хотят предоставлять доступ к их подсистемам и программному коду, но готовы соблюдать протокол общего мониторинга и сообщать центральной системе информацию о том, как работают их компоненты, связи, активы. Команды могут направлять только те метрики, которые считают нужными через REST-интерфейс или JSON-последовательности и устанавливать собственный "expiry period" данных для поступления предупреждения дежурным инженерам и срабатывания мониторинга изменения состояния данных тогда, когда это необходимо.

Таким образом, в ходе мастер-класса Денис рассказал и показал на примере работы с API платформы «Центральный Пульт» как создавать новые объекты, получать данные об объектах и отправлять их обратно в систему, добавлять к объектам операции, аутентифицироваться в системе с помощью токена, настраивать виджеты и др. Остались вопросы? Смотрите полную запись онлайн мастер-класса на Youtube-канале MONHOUSE.