Management API через REST#

Введение#

DataGrid поставляется с REST-расширением для Management API (подробнее об управлении написано в разделе «Сценарии администрирования» документа «Руководство администратора»). Это расширение позволяет управлять кластером с помощью HTTP-запросов, используя спецификацию OpenAPI.

Настройка#

При добавлении модуля ignite-openapi-management в classpath REST-расширение автоматически разворачивается на сервере Jetty, который настроен с помощью ConnectorConfiguration. Подробнее о конфигурации коннектора написано в документе «Справочник конфигурационных файлов и параметров».

Конечные точки#

Спецификация OpenAPI#

https://<host>:<port>/management/api

Возвращает спецификацию OpenAPI для Management API и позволяет использовать ее в Swagger UI и других совместимых инструментах.

Вызов команд#

https://<host>:<port>/management/invoke/<command>[?param1=value1&param2=value2]

Примеры:

  • https://<host>:<port>/management/invoke/state — возвращает текущее состояние кластера;

  • https://<host>:<port>/management/invoke/set-state?state=INACTIVE — меняет состояние кластера на INACTIVE.

Безопасность#

При включенной аутентификации для доступа к Management API требуется токен сессии или учетные данные пользователя с достаточными для выполнения команды правами. Для аутентификации используйте команду authenticate:

https://<host>:<port>/ignite?cmd=authenticate&ignite.login=[user]&ignite.password=[password]

Пример запроса с токеном сессии:

https://<host>:<port>/management/invoke/state?sessionToken=<token>