О RAIDIX REST API

REST API (англ. «Representational State Transfer Application Public Interface») предоставляет внешним приложениям возможность запрашивать и обновлять данные в механизме управления СХД на базе ПО RAIDIX. REST API предоставляет данные об объектах ПО RAIDIX в формате JSON (англ. «JavaScript Object Notation»).

REST API версии 1.0.0 поддерживает операции аутентификации и запроса с помощью стандартных методов HTTP POST, GET, PUT, DELETE.

Документация REST API

Чтобы открыть документацию REST API, в адресной строке введите

<controller_ip>/api-docs

Просмотр документации доступен без авторизации.

Начало работы с API

Чтобы выполнять API-запросы, требуется аутентифицировать пользователя.

Пользователями могут быть:

• admin
• системные пользователи с ролью «администратор»
• системные пользователи с ролью «оператор»

Пользователям с ролью "операторы" доступны только аутентификация и GET-запросы.

Аутентификация реализована через пользовательские сессии. Подробнее о настройке продолжительности сессии см. в разделе Параметры пользовательских сессий.

Примеры

Запросы могут быть выполнены прямо из документации REST API, при этом будет показан сформированный curl-запрос (без токена сессии). Пример использования токена сессии в curl-запросе см. ниже в примерах.

Пример curl-запроса аутентификации:

curl -X 'POST' 'https://<controller_ip>/api/auth' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{"login": "admin","password": "<admin_password>", "language": "en"}' --cookie-jar ./mysession

где

• ./mysession - путь до файла, в который будет сохранён текущий токен сессии.

Пример curl-запроса для получения списка LUN:

curl -X 'GET' 'https://<controller_ip>/api/lun' -H 'accept: application/json' --cookie ./mysession

где

• ./mysession - путь до файла, в котором сохранён текущий токен сессии.