3.12.5.3. JSON API
JSON API Сервера предоставляет возможность получать дополнительную диагностическую информацию по Серверу и базам данных, а также и выполнять некоторые команды управления.
Сервер и базы данных публикуют иерархию логических объектов, представляющих внутренние блоки функциональности. Каждый такой объект предоставляет набор команд.
Клиент формирует запрос к JSON API в виде JSON-объекта, в котором указывает:
Объект в Сервере или базе данных, которому запрос адресован
Вызываемую команду
Специфичные для команды параметры вызова
Сервер направляет запрос к целевому объекту, который выполняет его и формирует ответ, содержащий:
Синхронный результат - результат в виде JSON-объекты, сформированный по завершении выполнения запроса, который сразу возвращается клиенту
Множественный результат - опциональный результат, состоящий из множества записей, который возвращается серией отдельных запросов
Если в результате выполнения запроса порождён множественный результат, то Сервер выделяет для него уникальный идентификатор и регистрирует в реестре “длинных” запросов, который возвращает в синхронном результате.
Используя уникальный идентификатор множественного результата, клиент выполняет его выборку с помощью отдельных специальных запросов.
Множественный результат удаляется из реестра:
по завершении выборки
по команде отмены выборки
по истечении таймаута отсутствия активности (когда клиент не выполняет выборку)
Настройки данного механизма содержатся в блоке json_api файла local.jsonc.
<домашняя папка>\.astra.historian.server\config\local.jsonc
|