Различия
Показаны различия между двумя версиями страницы.
Следующая версия | Предыдущая версия | ||
dpi:dpi_components:dpiui:jsonrpc_api:start [2020/10/21 12:57] – создано arusnak | dpi:dpi_components:dpiui:jsonrpc_api:start [Дата неизвестна] (текущий) – удалено - внешнее изменение (Дата неизвестна) 127.0.0.1 | ||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ===== 5 Описание программного интерфейса JSON-RPC ===== | ||
- | {{indexmenu_n> | ||
- | ==== Описание | ||
- | Все запросы на сервер отправляются методом POST по адресу https:// | ||
- | |||
- | В теле запроса передается массив [] объектов типа | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Если в запросе передан массив из нескольких объектов, | ||
- | |||
- | Примечание: | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Ответ может вернуться с ошибкой. Ошибки подразделяются на две категории: | ||
- | |||
- | * Глобальные - обрабатываются на уровне модуля json-rpc. Например, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | * Локальные - обрабатываются на уровне Api внутри вызываемой функции. Например, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Несколько примеров запросов с использованием CURL === | ||
- | |||
- | Получить версию приложения: | ||
- | < | ||
- | curl -b cookie.txt -c cookie.txt -X POST -k -i ' | ||
- | </ | ||
- | |||
- | Выполнить авторизацию: | ||
- | < | ||
- | curl -b cookie.txt -c cookie.txt -X POST -k -i ' | ||
- | rue}," | ||
- | </ | ||
- | |||
- | Получить файл конфигурации DPI: | ||
- | < | ||
- | curl -b cookie.txt -c cookie.txt -X POST -k -i ' | ||
- | </ | ||
- | |||
- | |||
- | ==== Общие функции | ||
- | |||
- | === Api_GetAppVersion | ||
- | |||
- | Выводит версию приложения. | ||
- | |||
- | Параметры отсутствуют. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | |||
- | }] | ||
- | </ | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDics === | ||
- | |||
- | Выводит словари. | ||
- | |||
- | Параметры: | ||
- | |||
- | * DicsKeys - Array: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ==== Функции аутентификации и авторизации | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_Auth | ||
- | |||
- | Проверяет и выводит результат: | ||
- | |||
- | Параметры отсутствуют. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример ответа, | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример ответа, | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_Login | ||
- | |||
- | Авторизует пользователя | ||
- | |||
- | Параметры: | ||
- | |||
- | * username - string: | ||
- | * password - string: | ||
- | * remember - bool: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример неуспешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Если авторизация прошла успешно, | ||
- | |||
- | === Api_Logout === | ||
- | |||
- | Деавторизацует текущего пользователя. | ||
- | |||
- | Параметры отсутствуют. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | ==== Управление профилем пользователя | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetMyProfile | ||
- | |||
- | Выводит профиль пользователя. | ||
- | |||
- | Параметры отсутствуют. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_SaveMyProfile | ||
- | |||
- | Изменение профиля пользователя. | ||
- | |||
- | Параметры: | ||
- | |||
- | * MyProfile - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_ChangeMyPassword | ||
- | |||
- | Изменение пароля пользователя. | ||
- | |||
- | Параметры: | ||
- | |||
- | * OldPassword - object: | ||
- | * NewPassword - string: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | ==== Управление пользователями | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetUsers | ||
- | |||
- | Получение списка пользователей. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса с идентификатором пользователя: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос с идентификатором пользователя: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос без параметров: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_SaveUser | ||
- | |||
- | Создание/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * user - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_DeleteUser | ||
- | |||
- | Удаляет пользователя. | ||
- | |||
- | Параметры: | ||
- | |||
- | * user - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | ==== Управление ролями | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetRoles | ||
- | |||
- | Получение списка пользователей. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса с идентификатором роли: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос с идентификатором роли: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос без параметров: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_SaveRole | ||
- | |||
- | Создание/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * role - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | === Api_DeleteRole | ||
- | |||
- | Удаление роли. | ||
- | |||
- | Параметры: | ||
- | |||
- | * role - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | ==== Управление оборудованием | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetHardwares | ||
- | |||
- | Получить список оборудований. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса с идентификатором оборудования: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос с идентификатором оборудования: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример успешного ответа на запрос без параметров: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_SaveHardware | ||
- | |||
- | Создание/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * hardware - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_DeleteHardware | ||
- | |||
- | Удаление оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * hardware - object: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_RestartHardware | ||
- | |||
- | Перезапуск оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_ReloadHardware | ||
- | |||
- | Обновление горячих параметров. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_TestConnectToHardware | ||
- | |||
- | Проверка доступности оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiConfig | ||
- | |||
- | Получение DPI-конфигурации оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_ValidateDpiConfig | ||
- | |||
- | Валидация DPI-конфигурации оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * Config - string: конфигурация | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | configuration : SUCCESS\n" | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_SetDpiConfig | ||
- | |||
- | Установка DPI-конфигурации на оборудование. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * Config - string: конфигурация | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiConfigHistory | ||
- | |||
- | Получение истории установки DPI-конфигураций на оборудовании. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiConfigFile | ||
- | |||
- | Получение содержимого файла DPI-конфигурации. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * File - string: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiInfo | ||
- | |||
- | Получение информации об оборудовании. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | "CPU op-mode(s)": | ||
- | "Byte Order": | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | "NUMA node(s)": | ||
- | " | ||
- | "CPU family": | ||
- | " | ||
- | " | ||
- | "CPU MHz": " | ||
- | " | ||
- | " | ||
- | "L1d cache": | ||
- | "L1i cache": | ||
- | "L2 cache": | ||
- | "L3 cache": | ||
- | "NUMA node0 CPU(s)": | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiResourcesUsageTick | ||
- | |||
- | Получение информации о текущем состоянии производительности оборудования. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDpiResourcesStatsUsageForPeriod | ||
- | |||
- | Получение информации о состоянии производительности оборудования за период. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * Period - object: | ||
- | * PeriodType - string: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_ProcessDpiStatLog | ||
- | |||
- | Запускает процесс обработки лога статистики DPI. Обычно запускается автоматически по расписанию. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetStatLogTail | ||
- | |||
- | Получение " | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * Tail - int: длина " | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | : | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | ARP statistics: | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_DownloadStatLog | ||
- | |||
- | Получение идентификатора лог-файла статистики для скачивания. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Получив идентификатор, | ||
- | |||
- | === Api_GetAlertLogTail | ||
- | |||
- | Получение " | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | * Tail - int: длина " | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_DownloadAlertLog | ||
- | |||
- | Получение идентификатора лог-файла сообщений для скачивания. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Получив идентификатор, | ||
- | |||
- | ==== Управление нотификациями | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetLastNotifications | ||
- | |||
- | Получение списка последних нотификаций. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Page - int: | ||
- | * Size - int: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | : Success: loaded.", | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_GetUnreadedNotificationsCount | ||
- | |||
- | Получение количества непрочитанных CRITICAL нотификаций. | ||
- | |||
- | Параметры отсутствуют. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | === Api_SetNotificationsReaded | ||
- | |||
- | Отметить нотификации как прочитанные. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Notifs - array: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | === Api_DeleteNotifications | ||
- | |||
- | Удалить нотификации. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Notifs - array: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | ==== Отправка ошибок | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_SendError | ||
- | |||
- | Отправка сообщения об ошибке на почту указанную в конфигурации. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Params - object: модель сообщения об ошибке | ||
- | |||
- | Параметры конфигурации отправки: | ||
- | |||
- | * subject - string: тема сообщения | ||
- | * body - string: тело сообщения | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * alertLog - bool: включение файла с логами уведомлений в сообщение | ||
- | * statLog - bool: включение файла с логами состояния оборудования в сообщение | ||
- | * uiLog - bool: включение файла с логами dpiui в сообщение | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_LogError | ||
- | |||
- | Запись информации об ошибке в dpiui-лог. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Content - string: тело сообщения об ошибке | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | ==== Управление абонентами | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetSubscribers | ||
- | Получение списка абонентов. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * login - string: имя пользователя | ||
- | * login_equal - string:... | ||
- | * ip - string: ip-адрес пользователя | ||
- | * ip_equal - string:... | ||
- | * bind_type - ... | ||
- | * services - ... | ||
- | * policings - ... | ||
- | * order_by - string: поле, по которому будет упорядочен список абонентов | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_SaveSubscriber | ||
- | |||
- | Сохранение модели абонента. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * Subscriber - object: модель абонента с новыми данными | ||
- | * SubscriberOld - object: модель абонента со старыми данными. Если данный параметры указан, | ||
- | |||
- | Пример запроса при создании абонента: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа при создании абонента: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | | ||
- | " | ||
- | " | ||
- | | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | Пример запроса при редактировании абонента: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа при редактировании абонента: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | | ||
- | " | ||
- | " | ||
- | | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_DeleteSubscriber | ||
- | |||
- | Удаление абонента. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * Subscriber - object: модель абонента | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | | ||
- | " | ||
- | " | ||
- | | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | ==== Управление услугами ==== | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Управление черными/ | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | == Api_GetBlTasks == | ||
- | Получение списка профилей Черных/ | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * title - string: имя профиля | ||
- | * white - int:0|1, если 0 - то профиль улуги Черного списка | ||
- | * task_id - int: идентификатор профиля | ||
- | * tasks_ids - string: идентификаторы профилей через запятую | ||
- | * not_in_tasks_ids - string: идентификаторы профилей через запятую | ||
- | * parent_ids_is_null - int: 0|1 | ||
- | * status - int: 0|1 => Выкл|Вкл | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | == Api_SaveBlTask == | ||
- | |||
- | Сохранение профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Form - object: модель данных из формы | ||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_DeleteBlTask == | ||
- | |||
- | Удаление профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | == Api_RunBlTask == | ||
- | Включение профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_StopBlTask == | ||
- | |||
- | Выключение профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_GetBlListItems == | ||
- | |||
- | Получение списка ресурсов профилей Черных/ | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * uri - string: ресурс | ||
- | * type - string: | ||
- | * task_id - int: идентификатор профиля | ||
- | * enabled - int: 0|1 => Выкл|Вкл | ||
- | * order_by - string: поле, по которому будет упорядочен список ресурсов | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | == Api_SaveBlListItem == | ||
- | |||
- | Сохранение ресурса профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * ListItem - object: модель ресурса | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_DeleteBlListItem == | ||
- | Удаление ресурса профиля Черных/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * ListItem - object: модель ресурса | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_ImportBlListItems == | ||
- | Импорт массива моделей ресурсов профиля Черных/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * Items - array: массив моделей ресурсов | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | == Api_ImportBlListItemsFromQoE == | ||
- | |||
- | Импорт ресурсов по категориям из QoE. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Task - object: модель профиля | ||
- | * Categories - string: идентификаторы категорий ресурсов из QoE через запятую | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_GetBlTargets == | ||
- | |||
- | Получение списка абонентов профилей Черных/ | ||
- | |||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * task_id - int: идентификатор профиля | ||
- | * target - string: логин абонента | ||
- | * status - int: статус абонента | ||
- | * order_by - string: поле, по которому будет упорядочен список абонентов | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_SaveBlTargets == | ||
- | |||
- | Сохранение нескольких абонентов профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Targets - array: массив моделей абонентов профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_SaveBlTarget == | ||
- | |||
- | Сохранение абонента профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * NewTarget - object: новая модель абонента профиля | ||
- | * OldTarget - object: старая модель абонента профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_DeleteBlTarget == | ||
- | |||
- | Удаление абонента профиля Черных/ | ||
- | Параметры: | ||
- | |||
- | * Target - object: модель абонента профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Управление записью PCAP === | ||
- | В разработке. | ||
- | |||
- | === Управление мини Firewall-ом === | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | == Api_GetMiniFirewallProfiles == | ||
- | |||
- | Получение списка профилей Мини Firewall. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * title - string: имя профиля | ||
- | * title_equal - string: точное имя профиля | ||
- | * profile_id - int: Идентификатор профиля | ||
- | * profile_id_not_eqaul - int: Идентификатор профиля | ||
- | * profile_ids - string: Строка с перечислением идентификаторов профилей через запятую | ||
- | * status - int: 0|1 => Выкл|Вкл | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | }] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | {...} | ||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Api_SaveMiniFirewallProfile == | ||
- | |||
- | Сохранение профиля Мини Firewall. | ||
- | Параметры: | ||
- | |||
- | * Form - object: модель данных из формы | ||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | }] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | == Api_DeleteMiniFirewallProfile == | ||
- | |||
- | Удаление профиля Мини Firewall. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | }] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_RunMiniFirewallProfile == | ||
- | |||
- | Запуск профиля Мини Firewall. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | }] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Api_StopMiniFirewallProfile == | ||
- | |||
- | Остановка профиля Мини Firewall. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [{ | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | }] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Управление L2 BRAS === | ||
- | В разработке. | ||
- | |||
- | === Управление L3 BRAS === | ||
- | В разработке. | ||
- | |||
- | === Управление CG NAT === | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | == Api_GetCgNatProfiles == | ||
- | |||
- | Получение списка CG NAT профилей. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * title - string: имя профиля | ||
- | * title_equal - string: точное имя профиля | ||
- | * profile_id - int: Идентификатор профиля | ||
- | * profile_id_not_eqaul - int: Идентификатор профиля | ||
- | * profile_ids - string: Строка с перечислением идентификаторов профилей через запятую | ||
- | * status - int: 0|1 => Выкл|Вкл | ||
- | * nat_type - int: Тип профиля (0 => CG NAT, 1 => 1:1) | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | {...}, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Api_SaveCgNatProfile == | ||
- | |||
- | Сохранение CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Form - object: модель данных из формы | ||
- | * Task - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | == Api_DeleteCgNatProfile == | ||
- | |||
- | Удаление CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | == Api_RunCgNatProfile == | ||
- | |||
- | Запуск CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Api_StopCgNatProfile == | ||
- | |||
- | Остановка CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Api_GetCgNatDetailStatus == | ||
- | |||
- | Получение подробного статуса CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * profile_id - int: Идентификатор профиля | ||
- | * profile_ids - string: Строка с перечислением идентификаторов профилей через запятую | ||
- | * proto - string: Используемый протокол (TCP / UDP) | ||
- | * ip_mask - string: IP маска( 0x0 / 0x1) | ||
- | * nthr - int: Номер потока (0 / 1) | ||
- | * whip - string: Белый IP адрес | ||
- | * num_port - int: Общее количество портов ( >= ) | ||
- | * use_port - int: Используемое количество портов ( >= ) | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | {...}, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | |||
- | == Api_GetCgNatFullStatus == | ||
- | Получение общего статуса CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * profile_id - int: Идентификатор профиля | ||
- | * profile_ids - string: Строка с перечислением идентификаторов профилей через запятую | ||
- | * proto - string: Используемый протокол (TCP / UDP) | ||
- | * ip_mask - string: IP маска( 0x0 / 0x1) | ||
- | * nthr - int: Номер потока (0 / 1) | ||
- | * whip - string: Белый IP адрес | ||
- | * num_port - int: Общее количество портов ( >= ) | ||
- | * use_port - int: Используемое количество портов ( >= ) | ||
- | * num_addr - int: Общее количество адресов ( >= ) | ||
- | * use_addr - int: Используемое количество адресов ( >= ) | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | == Api_GetCgNatSubscribersStatus == | ||
- | |||
- | Получение статуса абонентов CG NAT профиля. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * order_by - string: поле, по которому будет упорядочен список профилей | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * profile_id - int: Идентификатор профиля | ||
- | * profile_ids - string: Строка с перечислением идентификаторов профилей через запятую | ||
- | * ipv4 - string: Серый IP адрес | ||
- | * whiteip - string: Белый IP адрес | ||
- | * sess_tcp - int: Количество TCP сессий ( >= ) | ||
- | * sess_udp - int: Количество UDP сессий ( >= ) | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | {...}, | ||
- | ... | ||
- | |||
- | ] | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Управление защитой от DOS и DDOS атак === | ||
- | В разработке. | ||
- | |||
- | === Управление кешированием === | ||
- | В разработке. | ||
- | |||
- | === Управление уведомлениями абонентов === | ||
- | В разработке. | ||
- | |||
- | === Управление блокировкой и заменой рекламы === | ||
- | В разработке. | ||
- | |||
- | === Управление бонусной программой === | ||
- | В разработке. | ||
- | |||
- | |||
- | ==== Управление тарифами ==== | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetPolicingProfiles | ||
- | Получение списка профилей тарифных планов. | ||
- | Параметры: | ||
- | |||
- | * Params - object: параметры поиска(необязательный параметр) | ||
- | Возможные параметры поиска Params: | ||
- | * page - int: номер страницы | ||
- | * size - int: размерность массива с результатом | ||
- | * hardware_id - int: идентификатор оборудования | ||
- | * title - string: имя профиля | ||
- | * individual - int:0|1 | ||
- | * profile_id - int: идентификатор профиля тарифного плана | ||
- | * order_by - string: поле, по которому будет упорядочен список абонентов | ||
- | * order_dir - string: упорядочивание списка по возрастанию(" | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | |||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | ] | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_SavePolicingProfile | ||
- | |||
- | Сохранение модели абонента. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля тарифного плана с новыми данными | ||
- | * Config - string: конфигурация тарифного плана. Если данный параметр указан, | ||
- | |||
- | Пример запроса при сохранении профиля: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа при создании профиля: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Api_SavePolicingProfileConfig | ||
- | |||
- | Сохранение конфигурации профиля тарифного плана. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля тарифного плана. | ||
- | * Config - string: конфигурация тарифного плана. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | config: " | ||
- | config_updated: | ||
- | dpi_name: | ||
- | enabled: " | ||
- | hardware_id: | ||
- | individual: | ||
- | profile_id: | ||
- | status: " | ||
- | subs_updated: | ||
- | title: " | ||
- | user_id: " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Api_DeletePolicingProfile | ||
- | |||
- | Удаление профиля тарифного плана. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Profile - object: модель профиля тарифного плана. | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | config: " | ||
- | config_updated: | ||
- | dpi_name: | ||
- | enabled: " | ||
- | hardware_id: | ||
- | individual: | ||
- | profile_id: | ||
- | status: " | ||
- | subs_updated: | ||
- | title: " | ||
- | user_id: " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | config: " | ||
- | config_updated: | ||
- | dpi_name: | ||
- | enabled: " | ||
- | hardware_id: | ||
- | individual: | ||
- | profile_id: | ||
- | status: " | ||
- | subs_updated: | ||
- | title: " | ||
- | user_id: " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | ==== Управление приоретизацией по протоколам (DSCP) | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetDscpProtocolsConfig | ||
- | |||
- | Получение конфигурации приоретизации по протоколу DSCP. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_SetDscpProtocolsConfig | ||
- | |||
- | Установка конфигурации приоретизации по протоколу DSCP. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * Config - string: тело конфигурации | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetDscpProtocolsConfigHistory | ||
- | |||
- | Получение истории изменения конфигураций приоретизации по протоколу DSCP. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_GetDscpProtocolsConfigFile | ||
- | |||
- | Получение файла конфигурации из истории по имени файла. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * File - string: имя файла | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | ==== Управление приоретизацией по ASN ==== | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | === Api_GetAsnDscpConfig | ||
- | |||
- | Получение конфигурации приоретизации по ASN. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_SetAsnDscpConfig | ||
- | |||
- | Установка конфигурации приоретизации по ASN. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * AsnConfig - string: тело конфигурации ASN | ||
- | * AsnDscpConfig - string: тело конфигурации ASNDSCP | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetAsnDscpConfigHistory | ||
- | |||
- | Получение истории изменения конфигураций приоретизации по ASN. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ... | ||
- | ] | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | |||
- | === Api_GetAsnDscpConfigFile | ||
- | |||
- | Получение файла конфигурации из истории по имени файла. | ||
- | |||
- | Параметры: | ||
- | |||
- | * Id - int: идентификатор оборудования | ||
- | * File - string: имя файла | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | } | ||
- | |||
- | ] | ||
- | </ | ||
- | |||
- | Пример успешного ответа: | ||
- | < | ||
- | { | ||
- | |||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | | ||
- | } | ||
- | |||
- | } | ||
- | </ | ||
- | |||
- | ==== Управление QoE ==== | ||
- | |||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | * [[dpi: | ||
- | |||
- | |||
- | === Api_GetQoEClientPredefinedReport === | ||
- | |||
- | Получение QoE отчета. | ||
- | |||
- | Параметры: | ||
- | * Config - Object: конфигурация отчета | ||
- | * Params - Object: параметры отчета (фильтры) | ||
- | |||
- | == Пример: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | " | ||
- | ], | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ] | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | |||
- | ], | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ... | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | == Пример: | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | " | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | ] | ||
- | } | ||
- | }, | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | |||
- | }, | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | ........ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | }, | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | ], | ||
- | " | ||
- | } | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | === Api_GetQoEFilters === | ||
- | |||
- | Пример запроса: | ||
- | < | ||
- | [ | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | } | ||
- | }, | ||
- | " | ||
- | } | ||
- | ] | ||
- | </ | ||
- | |||
- | Пример ответа: | ||
- | < | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | { | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " | ||
- | " |