API
В API OneBridge используются POST-, GET-, PUT- и DELETE-запросы. Тип запроса указан отдельно для каждого метода.
Структура URI-запросов:
Каждый URI начинается с URL-адреса API http://<IP-address:port>/api/
, за ним следует название метода и параметры, при необходимости. Например, полный запрос для получения информации о сервере может быть записан так: http://127.0.0.1:8000/api/info
.
Список API-методов ядра системы OneBridge, доступных для вызова:
Resources
get info
Параметр | Значение |
---|---|
Описание | возвращает основную информацию о сервере, локальное и мировое время |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | без параметров |
Ответ | возвращает JSON файл со структурой:
|
get performance
Параметр | Значение |
---|---|
Описание | возвращает данные по работе сервера для отображения графиков работы памяти и процессора |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | без параметров |
Ответ | возвращает JSON файл со структурой, которая содержит объекты, описывающие состояние памяти и процессора:
ram: массив объектов с информацией о памяти
cpu: массив объектов с информацией о процессоре
|
get utilization
Параметр | Значение |
---|---|
Описание | возвращает данные по количеству используемой памяти сервера |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | без параметров |
Ответ | возвращает JSON файл со структурой:
|
Execution
get job_params
Параметр | Значение |
---|---|
Описание | возвращает информацию о параметрах запуска задания |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | path: string |
Ответ | возвращает JSON файл со структурой:
|
get run_by_id
Параметр | Значение |
---|---|
Описание | возвращает задание по идентификатору |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | id: string |
Ответ | возвращает JSON файл со структурой:
|
get runs
Параметр | Значение |
---|---|
Описание | возвращает информацию об отработавшем задании |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
from: date-time, (не обязательный) |
Ответ | возвращает JSON файл со структурой:
|
get runs_log
Параметр | Значение |
---|---|
Описание | запрашивает журнал выполнения запуска задания |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
id: string, |
Ответ | возвращает строку (текст) |
get runs_num
Параметр | Значение |
---|---|
Описание | возвращает общее количество заданий, можно фильтровать по статусу, дате и имени файла |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
from: date-time, (не обязательный) |
Ответ | возвращает JSON файл со структурой:
|
get runs_params
Параметр | Значение |
---|---|
Описание | возвращает значение параметров для указанного задания |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | id: string |
Ответ | возвращает JSON файл со структурой:
|
post runs
Параметр | Значение |
---|---|
Описание | запускает задание в работу и возвращает номер запущенного задания |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
на вход нужно подать JSON файл со структурой:
|
Ответ | возвращает JSON файл со структурой:
|
Projects
get directory
Параметр | Значение |
---|---|
Описание | возвращает информацию по указанной папке |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | path: string |
Ответ | возвращает JSON файл со структурой:
|
get project
Параметр | Значение |
---|---|
Описание | возвращает информацию по указанному проекту |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | path: string |
Ответ | возвращает JSON файл со структурой:
|
get file
Параметр | Значение |
---|---|
Описание | возвращает информацию по выбранному файлу |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
get tree
Параметр | Значение |
---|---|
Описание | возвращает информацию о содержимом дерева проектов |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса | без параметров |
Ответ | возвращает JSON файл со структурой:
|
post project
Параметр | Значение |
---|---|
Описание | создает проект |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post project_rename
Параметр | Значение |
---|---|
Описание | меняет имя проекта |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post directory
Параметр | Значение |
---|---|
Описание | создает папку |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post directory_rename
Параметр | Значение |
---|---|
Описание | меняет название папки |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post file
Параметр | Значение |
---|---|
Описание | создает новый файл |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post file_rename
Параметр | Значение |
---|---|
Описание | меняет имя файла |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
put file
Параметр | Значение |
---|---|
Описание | заменяет контент существующего файла |
Метод | PUT |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
delete directory
Параметр | Значение |
---|---|
Описание | удаляет папку |
Метод | DELETE |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
delete file
Параметр | Значение |
---|---|
Описание | удаляет файл |
Метод | DELETE |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
delete project
Параметр | Значение |
---|---|
Описание | удаляет проект |
Метод | DELETE |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
Schedules
get schedules
Параметр | Значение |
---|---|
Описание | возвращает список расписаний |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post schedules
Параметр | Значение |
---|---|
Описание | создаёт расписание |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post schedules_toggle
Параметр | Значение |
---|---|
Описание | изменяет состояние расписания (вкл/выкл) и возвращает новое состояние |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post schedules_rename
Параметр | Значение |
---|---|
Описание | Меняет название расписания |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
delete schedules
Параметр | Значение |
---|---|
Описание | Удаляет расписание |
Метод | DELETE |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
patch schedules
Параметр | Значение |
---|---|
Описание | Изменяет атрибуты расписания |
Метод | PATCH |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
Event listeners
get event_listeners
Параметр | Значение |
---|---|
Описание | возвращает список обработчиков событий |
Метод | GET |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ | возвращает JSON файл со структурой:
|
post event_listeners
Параметр | Значение |
---|---|
Описание | создает обработчик событий |
Метод | POST |
Пример запроса |
|
Пример ответа | без ответа |
Параметры запроса |
|
Ответ | без ответа |
post event_listeners_toggle
Параметр | Значение |
---|---|
Описание | изменяет состояние обработчика событий (вкл/выкл) и возвращает новое состояние |
Метод | POST |
Пример запроса |
|
Пример ответа |
|
Параметры запроса |
|
Ответ |
|
post event_listeners_rename
Параметр | Значение |
---|---|
Описание | Меняет название обработчика событий |
Метод | POST |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
delete event_listeners
Параметр | Значение |
---|---|
Описание | Удаляет обработчик событий |
Метод | DELETE |
Пример запроса |
|
Пример ответа | |
Параметры запроса |
|
Ответ | ничего не возвращает |
patch event_listeners
Параметр | Значение |
---|---|
Описание | Изменяет значения атрибутов обработчика событий |
Метод | PATCH |
Пример запроса |
изменить jobfile в action с "copy.grf" на "filter.grf"
|
Пример ответа |
|
Параметры запроса |
Все поля опциональные. Но при смене типа события event с "job" на "file" и наоборот, а так же при смене действия action с "Command" на "StartJob" и наоборот - нужно заполнить все сопутствующие атрибуты.
Например, если обработчик был настроен на event "job", и нужно заменить его на event "file", то нужно будет задать значение и для атрибутов filesystem, check, path, interval.
|
Ответ | возвращает JSON файл со структурой:
|