API модуля sessions

Последние изменения: 27.08.2025

API - методы модуля sessions

Модуль sessions является сервисом группового конфигурирования различных устройств путем создания групповых сессий, передачи их на исполнение и мониторинга состояния исполнения. Исполнение конфигурационных задач выполняется отдельными программными компонентами - исполнителями(workers) в автономном режиме. Модуль sessions взаимодействует с ними используя различные драйверы(drivers) через каналы связи, описываемые соединениями(connections). Конфигурационные сессии(sessions) состоят из конфигурационных заданий(tasks). Каждое задание представляет собой очередь(queue) действий(actions), которые должны быть исполнены для заданного устройства(device). Типовые действия и содержащие их очереди должны быть сохранены в виде шаблонов (queue templates) для последующего создания заданий на их основе. Типы поддерживаемых действий (action types) определяются драйвером. Модуль sessions позволяет сохранять в своей базе данных конфигурационные сессии и затем, по запросу, выполнять синхронизацию состояния заданных сессий (всех, входящих в них заданий) с их состоянием у одного или более исполнителей.

Таблица 1. Сводная таблица всех API методов модуля sessions

Описание	URL	Метод
Информация о версии и состоянии окружения	/sessions/version /sessions/api/version	GET
Чтение списка драйверов и типов поддерживаемых действий	/sessions/api/driver	GET
Чтение исполнителей	/sessions/api/worker	GET
Создание нового действия	/sessions/api/add_action_template	POST
Проверка корректности действия	/sessions/api/test_action_template	POST
Чтение действий	/sessions/api/action_template	GET
Удаление действий	/sessions/api/remove_action_template	GET
Редактирование действий	/sessions/api/update_action_template	POST
Создание нового шаблона	/sessions/api/add_queue_template	POST
Чтение шаблонов	/sessions/api/queue_template	GET
Удаление шаблонов	/sessions/api/remove_queue_template	GET
Редактирование шаблона	/sessions/api/update_queue_template	POST
Создание новой конфигурационной сессии	/sessions/api/add_session	POST
Чтение конфигурационных сессий	/sessions/api/session	GET
Редактирование конфигурационных сессий	/sessions/api/update_session	POST
Получение статистики исполнения конфигурационных сессий	/sessions/api/session_stats	GET
Удаление конфигурационной сессии	/sessions/api/remove_session	GET
Создание новых заданий	/sessions/api/add_task	POST
Чтение заданий	/sessions/api/task	GET
Удаление заданий	/sessions/api/remove_task	GET
Создание сеансов синхронизации	/sessions/api/add_sync	POST
Чтение сеансов синхронизации	/sessions/api/sync	GET
Удаление сеансов синхронизации	/sessions/api/remove_sync	GET
Создание подключения к устройству	/sessions/api/add_device_connection	POST
Создание нескольких подключений к устройству	/sessions/api/add_device_connections	POST
Чтение подключений к устройствам	/sessions/api/device_connection	GET
Редактирование подключения к устройству	/sessions/api/update_device_connection	POST
Удаление подключений к устройствам	/sessions/api/remove_device_connections	GET
Тест наличия связи при подключении к устройству	/sessions/api/test_device_connections	POST
Чтение лога действий пользователей	/sessions/api/log	GET
Заказ автоматического формирования «белых списков»	/sessions/api/order_wl	GET
Получение результата формирования «белых списков»	/sessions/api/get_wl	GET

Информация о версии и состоянии окружения

GET запрос:

URL	Список параметров	Пример запроса
/sessions/version		/sessions/version

Ответ:

BODY

{

"Version": "0.0.9",

"Database": "sqlite",

"Drivers": [

"appsandbox"

]

}

Чтение списка драйверов и типов поддерживаемых действий

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/driver		/sessions/api/driver

Ответ:

BODY

[

{

"id": "appsandbox",

"desc": "Appsandbox driver",

"action_types": [

{

"id": "TariffSchedule",

"desc": "Установка тарифного расписания",

"driver_id": "appsandbox"

{

"id": "ActiveEnergyProfilePeriod",

"desc": "Установка периода профиля мощности",

"driver_id": "appsandbox"

}

"supported_methods": {
"getAllDevicesList": true,
"getAllDevicesOnlineList": true,
"requiresConnections": false
}

}

]

Чтение исполнителей

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/worker

/sessions/api/worker?id=d93d05f7-9856-44cb-a5ae-7c6b8c3db76b

Ответ:

BODY

[

{

"id": "d93d05f7-9856-44cb-a5ae-7c6b8c3db76b",

"desc": "Local appsandbox service",

"driver": {

"id": "appsandbox",

"desc": "Appsandbox driver"

"connection": {

"id": "a4a10bc8-db93-4d4b-90eb-11c995613623",

"desc": "Default local appsandbox connection",

"data": {

"conn_string": "http://127.0.0.1:80/"

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id

Создание нового действия

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_action_template		/sessions/api/add_action_template

BODY

{

"driver_id": "appsandbox",

"type_id": "GetPhobosVersion",

"desc": "Запрос версии ПО",

"data": {

"cmd": "version"

}

Ответ:

BODY

{

"result": true,

"id": "3897ce9c-4b61-4ff1-b214-2ae6bdb0c702"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
driver_id	string	id драйвера	обязательный параметр
type_id	string	id типа действия	обязательный параметр
desc	string	описание элемента	-
data	object	конфигурация для заданного действия	обязательный параметр

Проверка корректности действия

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/test_action_template		/sessions/api/test_action_template

BODY

{

"driver_id": "appsandbox",

"type_id": "GetPhobosVersion",

"desc": "Запрос версии ПО",

"data": {

"unknown": "

}

Ответ:

BODY

{

"result": false,

"error": "invalid action template data"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
driver_id	string	id драйвера	обязательный параметр
type_id	string	id типа действия	обязательный параметр
desc	string	описание элемента	-
data	object	конфигурация для заданного действия	обязательный параметр

Чтение действий

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/action_template

id, driver_id

/sessions/api/action_template?driver_id=appsandbox

/sessions/api/action_template?id=2b188882-70ad-4670-b2c3-44cc62e37076

Ответ:

BODY

[

{

"id": "2b83b135-1186-43eb-a35b-23ba525109d0",

"driver_id": "appsandbox",

"type_id": "GetPhobosVersion",

"desc": "Запрос версии ПО",

"data": {

"cmd": "version"

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
driver_id	string	фильтрация по driver_id - возвращаются только действия, поддерживаемые заданным драйвером	параметр может отсутствовать

Удаление действий

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_action_template	id	/sessions/api/remove_action_template?id=id=24be6ade-12d8-4b4b-be23-6c168ea6c4be

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	обязательный параметр

Редактирование действия

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/update_action_template		/sessions/api/update_action_template

BODY

{

"id": "30d56d56-6aa1-41ce-8132-bb791682f9ba",

"data": {

"cmd": "version2"

}

Ответ:

BODY

{

"result": true,

"id": "30d56d56-6aa1-41ce-8132-bb791682f9ba"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string	id редактируемого действия	обязательный параметр
driver_id	string	id драйвера	старое значение
type_id	string	id типа действия	старое значение
desc	string	описание элемента	старое значение
data	object	конфигурация для заданного действия	старое значение

Создание нового шаблона

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_queue_template		/sessions/api/add_queue_template

BODY

{

"desc": "Запрос версии ПО",

"actions": {

"0":{

"id": "2b83b135-1186-43eb-a35b-23ba525109d0"

"1":{

"id": "aa3a35b9-b8e3-4a03-8740-dabc9600b9f9"

}

"num_of_retries": 5,

"timeout": 3600

}

Ответ:

BODY

{

"result": true,

"id": "6e2e54aa-ff4d-4485-b214-ed0562646082"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
desc	string	описание элемента	-
timeout	int	таймаут ожидания исполнения каждого действия	определяется драйвером
num_of_retries	int	кол-во попыток исполнения каждого действия	определяется драйвером
actions	object	упорядоченный перечень идентификаторов действий в шаблоне	обязательный параметр

Чтение шаблонов

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/queue_template

id, driver_id

/sessions/api/queue_template

/sessions/api/queue_template?id=2b188882-70ad-4670-b2c3-44cc62e37076

Ответ:

BODY

[

{

"id": "762fe1f5-e724-4bb6-8fc9-b76c78e656bc",

"desc": "Запрос версии ПО",

"actions": {

"0": {

"id": "2b83b135-1186-43eb-a35b-23ba525109d0",

"driver_id": "appsandbox",

"type_id": "GetPhobosVersion",

"desc": "Запрос версии ПО",

"data": {

"cmd": "version"

}

"num_of_retries": 5,

"timeout": 3600

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
driver_id	string	фильтрация по driver_id - возвращаются только шаблоны, поддерживаемые заданным драйвером	параметр может отсутствовать

Удаление шаблонов

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_queue_template	id	/sessions/api/remove_queue_template?id=id=24be6ade-12d8-4b4b-be23-6c168ea6c4be

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	обязательный параметр

Редактирование шаблона

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/update_queue_template		/sessions/api/update_queue_template

BODY

{

"id" : "60dee4d8-f475-4f47-87b9-d362a0eb84ba",

"desc": "Меняем действия и таймаут",

"actions": {

"0":{

"id": "2b83b135-1186-43eb-a35b-23ba525109d0"

"1":{

"id": "f77032d6-4fd0-451e-8b47-043745cf7f6b"

}

"timeout": 10000

}

Ответ:

BODY

{

"result": true,

"id": "60dee4d8-f475-4f47-87b9-d362a0eb84ba"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string	id шаблона	обязательный параметр
desc	string	описание элемента	старое значение
timeout	int	таймаут ожидания исполнения каждого действия	старое значение
num_of_retries	int	кол-во попыток исполнения каждого действия	старое значение
actions	object	упорядоченный перечень идентификаторов действий в шаблоне	старое значение

Создание новой конфигурационной сессии

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_session		/sessions/api/add_session

BODY

{

"desc": "Отключение всем реле",

"ttl": 86400

}

Ответ:

BODY

{

"result": true,

"id": "2872c000-6b4d-4837-9acb-f91424991bb1"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
desc	string	описание элемента	-
ttl	int	время жизни	не ограничено

Чтение конфигурационных сессий

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/session

id, sync_id, status, driver_id

/sessions/api/session

/sessions/api/session?id=263332ad-95fa-4ebd-8ddc-93e530e25f7b

Ответ:

BODY

[

{

"id": "263332ad-95fa-4ebd-8ddc-93e530e25f7b",

"desc": "Отключение всем реле",

"status": "CREATED",

"ts_created": 1666273789,

"ts_updated": 0,

"ttl": 86400,

"sync_id": "

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
sync_id	string list	список запрашиваемых sync_id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все sync_id
status	string list	список запрашиваемых status, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все status
driver_id	string list	список запрашиваемых driver_id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все driver_id

Редактирование конфигурационной сессии

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/update_session		/sessions/api/update_session

BODY

{

"id": "7cb27905-8c09-44f2-ad93-c51d5f044847",

"desc": "Новое описание",

"ttl": 500,

"status": "DELETED"

}

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string	id редактируемой конфигурационной сессии	обязательный параметр
desc	string	описание элемента	остается старое значение параметра
ttl	int	время жизни	остается старое значение параметра
status	string	статус конфигурационной сессии: SUSPENDED – приостановить выполнение всех заданий сессии DELETED – отменить выполнение всех заданий сессии	остается старое значение параметра

Получение статистики исполнения конфигурационных сессий

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/session_stats

/sessions/api/session_stats?id=263332ad-95fa-4ebd-8ddc-93e530e25f7b

Ответ:

BODY

[

{

"session_id": "263332ad-95fa-4ebd-8ddc-93e530e25f7b",

"workers": 0,

"devices": 0,

"actions": 0,

"tasks": 0,

"progress": 0

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id

Удаление конфигурационной сессии

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_session	id	/sessions/api/remove_session?id=263332ad-95fa-4ebd-8ddc-93e530e25f7b

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string	id сессии	обязательный параметр

Создание новых заданий

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_task		/sessions/api/add_task

BODY

{

"worker_id": "d93d05f7-9856-44cb-a5ae-7c6b8c3db76b",

"devices": [7658743,7658744,7658745,7658746],

"connection_ids": [],

"queue_template_id": "24be6ade-12d8-4b4b-be23-6c168ea6c4be",

"session_id": "8625b3ec-0b7e-41e3-aae7-a9e79ef75f03",

"actions_data": []

}

Ответ:

BODY

{

"result": true,

"ids": [

"9fba99f4-7d14-4523-81cc-4ce83963ffdc",

"241b2bda-f78d-4731-adb4-7dd15d3cdda6",

"257e3e80-d21c-474d-8098-08d3aef7afac",

"a06dde02-4714-4d64-934c-6dda3017248b"

]

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
worker_id	string	id исполнителя	обязательный параметр
devices	int []	список устройств, для каждого устройства будет создано задание	обязательно должен быть указан либо список устройств, либо список подключений
connection_ids	string[]	список подключений, для каждого подключения будет создано задание	обязательно должен быть указан либо список устройств, либо список подключений
queue_template_id	string	id шаблона	обязательный параметр
session_id	string	id конфигурационной сессии	обязательный параметр
actions_data	objects[]	список входных параметров для каждого действия из шаблона, будут применены для всех устройств	опциональный параметр

Чтение заданий

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/task

id, session_id, worker_id, status

/sessions/api/task

/sessions/api/task?id=9fba99f4-7d14-4523-81cc-4ce83963ffdc,241b2bda-f78d-4731-adb4-7dd15d3cdda6

Ответ:

BODY

[

{

"id": "241b2bda-f78d-4731-adb4-7dd15d3cdda6",

"worker_id": "d93d05f7-9856-44cb-a5ae-7c6b8c3db76b",

"device_id": 7658744,

"queue_id": "6e66cfe5-dbad-49b5-9f94-8a0fc2117af7",

"queue_template_id": "09534b4b-b4cf-430e-a517-8b96bd01725c",

"session_id": "8625b3ec-0b7e-41e3-aae7-a9e79ef75f03",

"status": "CREATED",

"stage": 0,

"ts_created": 1666276295,

"ts_updated": 0

{

"id": "9fba99f4-7d14-4523-81cc-4ce83963ffdc",

"worker_id": "d93d05f7-9856-44cb-a5ae-7c6b8c3db76b",

"device_id": 7658743,

"queue_id": "83419261-a9f8-45c7-9bd5-b956f261ccdc",

"queue_template_id": "09534b4b-b4cf-430e-a517-8b96bd01725c",

"session_id": "8625b3ec-0b7e-41e3-aae7-a9e79ef75f03",

"status": "CREATED",

"stage": 0,

"ts_created": 1666276295,

"ts_updated": 0

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
session_id	string list	список запрашиваемых session_id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все session_id
worker_id	string list	список запрашиваемых worker_id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все worker_id
status	string list	список запрашиваемых status, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все status

Удаление заданий

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_task	id	/sessions/api/remove_task?id=9fba99f4-7d14-4523-81cc-4ce83963ffdc

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	обязательный параметр

Создание сеансов синхронизации

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_sync		/sessions/api/add_sync

BODY

{

"ttl": 100000,

"session_ids": ["9afc4518-039c-4568-94a7-83b76ca7be29"]

}

Ответ:

BODY

{

"result": true,

"id": "3cb26a32-271e-4d33-94e5-fdcf888f1e20"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
ttl	int	время жизни	не ограничено
session_ids	string[]	список id конфигурационных сессий	обязательный параметр

Чтение сеансов синхронизации

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/sync

id, status

/sessions/api/sync

/sessions/api/sync?status=SUCCESS,FAULT

Ответ:

BODY

[

{

"id": "3cb26a32-271e-4d33-94e5-fdcf888f1e20",

"status": "SUCCESS",

"ttl": 100000,

"ts_created": 1666713891,

"ts_updated": 1666713892,

"completeness": 100

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
status	string list	список запрашиваемых status, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все status

Удаление сеансов синхронизации

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_sync	id	/sessions/api/remove_sync?id=9fba99f4-7d14-4523-81cc-4ce83963ffdc

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	обязательный параметр

Создание подключения к устройству

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_device_connection		/sessions/api/add_device_connection

BODY

{

"device_id": 21466,

"conn_type": "HTTP_API_CONNECTION",

"data": {

"ipadd": "10.1.214.66",

"port": 80,

"user": "superAdmin",

"pass": "e5c05a47"

}

Ответ:

BODY

{

"result": true,

"id": "aea4c540-8d34-402d-b45f-be8b2327b11d"

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
device_id	int	id устройства	не обязательный параметр
conn_type	string	тип подключения	HTTP_API_CONNECTION
device_type	string	тип устройства	не обязательный параметр
data	object	конфигурация для заданного подключения	обязательный параметр

Создание нескольких подключений к устройству

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/add_device_connections		/sessions/api/add_device_connections

BODY

[

{

"device_id": 21465,

"conn_type": "HTTP_API_CONNECTION",

"data": {

"ipadd": "10.1.214.65",

"port": 80,

"user": "superAdmin",

"pass": "78fcf3f7"

}

{

"device_id": 21466,

"conn_type": "HTTP_API_CONNECTION",

"data": {

"ipadd": "10.1.214.66",

"port": 80,

"user": "superAdmin",

"pass": "e5c05a47"

}

]

Ответ:

BODY

{

"result":true,

"ids":["c9103bd9-4d59-4b89-beb8-5273475c6642","61000115-d474-42f6-8f3c-12105f1472dc"]

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
device_id	int	id устройства	не обязательный параметр
conn_type	string	тип подключения	HTTP_API_CONNECTION
device_type	string	тип устройства	не обязательный параметр
data	object	конфигурация для заданного подключения	обязательный параметр

Чтение подключений к устройствам

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/device_connection

id, device_id, device_type, connection_type

/sessions/api/device_connection

/sessions/api/device_connection?id=9fba99f4-7d14-4523-81cc-4ce83963ffdc,241b2bda-f78d-4731-adb4-7dd15d3cdda6

Ответ:

BODY

[

{

"id": "aea4c540-8d34-402d-b45f-be8b2327b11d",

"device_id": 21465,

"device_type": "MiniBS",

"conn_type": "HTTP_API_CONNECTION",

"data": {

"ipadd": "10.1.214.66",

"pass": "******",

"user": "superAdmin"

}

]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список запрашиваемых id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все id
device_id	int list	список запрашиваемых device_id, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все device_id
device_type	string list	список запрашиваемых device_type, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все device_type
connection_type	string list	список запрашиваемых connection_type, разделенных запятой	параметр может отсутствовать, в этом случае запрашиваются все connection_type

Редактирование подключения к устройству

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/update_device_connection		/sessions/api/update_device_connection

BODY

{

"id": "aea4c540-8d34-402d-b45f-be8b2327b11d",

"device_id": 21466,

"data": {

"ipadd": "10.1.112.12",

"port": 80,

"user": "superAdmin",

"pass": "e5c05a47"

}

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string	id подключения	обязательный параметр
device_id	int	id устройства	-
device_type	string	тип устройства	-
connection_type	string	тип подключения	-
data	object	конфигурация для заданного подключения	-

Удаление подключений к устройствам

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/remove_device_connections	id	/sessions/api/remove_device_connections?id=9fba99f4-7d14-4523-81cc-4ce83963ffdc, aea4c540-8d34-402d-b45f-be8b2327b11d

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	string list	список удаляемых id, разделенных запятой	обязательный параметр

Тест наличия связи для подключения к устройству

POST запрос:

URL	Список параметров	Пример запроса
/sessions/api/test_device_connections	/sessions/api/test_device_connections

BODY

{

"driver_id":"gateway",

"connection_ids": ["aea4c540-8d34-402d-b45f-be8b2327b11d", "ef8b2bae-9139-4ddd-9e8b-cd7255c0ff90"]

}

Ответ:

BODY

{

"aea4c540-8d34-402d-b45f-be8b2327b11d": true,

"ef8b2bae-9139-4ddd-9e8b-cd7255c0ff90": false

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
driver_id	string	id драйвера	обязательный параметр
connection_ids	string[]	cписок id тестируемых подключений	обязательный параметр

Чтение лога действий пользователей

GET запрос:

URL

Список параметров

Пример запроса

/sessions/api/logs

id, user, from, to, limit, offset, full

/sessions/api/log?from=1673966121&to=1673966122&limit=2&offset=1

/sessions/api/log?id=3&full=true

/sessions/api/log?user=admin&from=1673966122

Ответ:

BODY

[
{
"id": 2,
"user": "admin",
"ts": 1673966121,
"comment": "Создание синхронизационной сессии",
"request": ",
"req_body": ",
"resp_body": "
},
{
"id": 3,
"user": "admin",
"ts": 1673966122,
"comment": "Создание синхронизационной сессии",
"request": ",
"req_body": ",
"resp_body": "
}
]

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
id	int	id конкретной записи в логе	опциональный параметр, для запроса более детальной информации интересующей записи
user	string	имя пользователя	все пользователи
from	int	таймстамп времени, начиная с которого будет получен лог действий	0
to	int	таймстамп времени, вплоть до которого будет получен лог действий	таймстамп текущего момента времени
limit	int	ограничение кол-ва выдаваемых записей	50
offset	int	смещение выдаваемых записей	0
full	bool	true - возвращать поля reqest, req_body и resp_body	false

Заказ автоматического формирования «белых списков»

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/order_wl	depth, mode	/sessions/api/order_wl?depth=30&mode=2snr

Запрос:

BODY(опционально можно указать device_filter)

{

"bs_ids":[10535,10636,11966,11967,12302,12304,12331,12334]

}

Ответ:

BODY

{

"result": true

}

Описание параметров запроса

Имя параметра	Тип	Описание	Значение по умолчанию
depth	string	глубина запроса по времени, дней	180
mode	string	режим формирования белых списков: 2snr – привязывать устройства к тем БС, при работе через которые устройство имеет наибольшее значение суммы SNR приема и передачи rsss – привязывать устройства к тем БС, при работе через которые устройство имеет наибольший уровень RSSI rating – привязывать устройства к тем БС, которые имеют наивысший для заданного устройства рейтинг	rating
device_filter	json	Параметр, передаваемый опционально в BODY запроса, может содержать одно или несколько полей фильтрации:

Получение результатов формирования «белых списков»

GET запрос:

URL	Список параметров	Пример запроса
/sessions/api/get_wl	format	/sessions/api/get_wl?format=csv

Ответ:

BODY

{

"result": true,

"status": "created",

"ts_created": 1706604426,

"data": "{\"13845\":{\"modems\":1,\"x_ids\":[9837293]},\"13881\":{\"modems\":91,\"x_ids\":[9575211,9578907,9579463,9818203,9822927,9822935,9824435,9829879,9830371,9831267,9831755,9832019,9832027,9832211,9832463,9834991,9838503,9838663,9838747,9572304,9572404,9573460,9576988,9581912,9585140,9591860,9594564,9810084,9812032,9817952,9818216,9821640,9822100,9824668,9825028,9825036,9829680,9830040,9833200,9834052,9835432,9835504,9836056,9838364,9573761,9578137,9591269,9814065,9814313,9815505,9817925,9824873,9825565,9828609,9828901,9829677,9829881,9832457,9833957,9834997,9836049,9836613,9837781,9839073,9571770,9573162,9576986,9576990,9583490,9583902,9589998,9591006,9810082,9819066,9823710,9824406,9824670,9828598,9829234,9831742,9831810,9832034,9832190,9832194,9832466,9833122,9833202,9833214,9836746,9837262,9837278]}}"

}

Описание параметров запроса

Имя параметра

Тип

Описание

Значение по умолчанию

format

string

формат файла белых списков:

json, csv или ids

json

Описание параметров ответа

Имя параметра	Тип	Описание
result	bool	результат исполнения запроса
status	string	статус исполнения задачи формирования белых списков: active – белые списки в процессе формирования created – белые списки успешно сформированы fault – ошибка формирования белых списков
ts_created	int	таймстамп времени формирования белых списков(0 для статусов active и fault)
data	string	Строка, содержащая файл белых списков в соответствии с запрашиваемым форматом

Помогла ли вам статья?