Использование Swagger

Swagger — это интерактивная оболочка для изучения работы API. С помощью Swagger вы можете сгенерировать запрос для API-функции платформы и проверить как эта функция работает.

Чтобы перейти к веб-интерфейсу Swagger, откройте в браузере URL https://domain.com/swagger/

Разделы Swagger

Swagger содержит описание API следующих сервисов DCImanager 6:

• DCI back — основной сервис платформы;
• Auth (deprecated) — устаревшая версия сервиса авторизации;
• Auth v4 — актуальная версия сервиса авторизации;
• IPmanager — IPmanager 6 — сервис для работы с IP-адресами, пулами и сетями;
• Report service — сервис отчётов;
• BMC proxy service — сервис проксирования для подключения к BMC;
• Equipment service — сервис работы с оборудованием;
• Backup service — сервис резервного копирования платформы;
• Global search service — сервис глобального поиска в платформе;
• rDNS proxy service — сервис для работы с обратными PTR-записями. Для работы с сервисом установите модуль "Интеграция с DNSmanager 6". Без установленного модуля API-запросы будут выдавать ошибку 404.

Чтобы переключаться между сервисами, выберите нужный раздел в поле Select a definition.

Выбор раздела

Выполнение API-запросов

Обратите внимание!

API-запросы выполняются с реальными объектами платформы. Перед выполнением запроса убедитесь, что выполняемые действия не нарушат работу DCImanager 6.

Чтобы выполнить запрос:

1. Выберите нужную функцию и нажмите Try it out.
   
2. Введите требуемые параметры и тело запроса и нажмите Execute.
   

После выполнения запроса в разделе Responses отображается формат запроса для утилиты curl и ответ сервера.

Интерфейс раздела

Некоторые сервисы могут возвращать ошибку 503 и сообщение Unavailable в теле ответа. В этом случае запрос нужно выполнить повторно.

Пример ошибки