/Methods/GetISEventsArchiveSettings

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Пользователи >

/Methods/GetISEventsArchiveSettings

Возвращает настройки архива сообщений системы информационной безопасности. Значения берутся из проекта (DT), а частично переопределяются сохранёнными RT-настройками; источник каждого значения указан в поле source.

HTTP: POST /Methods/GetISEventsArchiveSettings

Право: ViewISLog.

Запрос

{}

Ответ

{
  "archiveId": 1,
  "dbType": { "value": "postgresql", "source": "DT" },
  "dbName": { "value": "events_db", "source": "DT" },
  "server": { "value": "localhost", "source": "DT" },
  "port": { "value": 5432, "source": "DT" },
  "user": { "value": "events_user", "source": "DT" },
  "maximumArchiveSize": { "value": 1024, "source": "DT" },
  "maximumTimeOfStoring": { "value": 31536000, "source": "DT" },
  "statisticsCountingPeriod": { "value": 3600, "source": "DT" },
  "serverTime": 1710000000123,
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

archiveId

integer

успех

Идентификатор архива

dbType

object

успех, задано соединение

Тип провайдера БД {value, source}

dbName

object

успех, задано соединение

Имя базы (location) {value, source}

server

object

успех, задано соединение

Хост сервера БД {value, source}

port

object

успех, задано соединение

Порт {value, source}

user

object

успех, задано соединение

Пользователь БД {value, source}

maximumArchiveSize

object

успех, заданы лимиты

Максимальный размер (МБ) {value, source}

maximumTimeOfStoring

object

успех, заданы лимиты

Максимальное время хранения (секунды) {value, source}

statisticsCountingPeriod

object

успех, заданы лимиты

Период подсчёта статистики (секунды) {value, source}

serverTime

integer

успех

Время сервера, Unix time в мс

code

integer

всегда

Результат метода

Поле source каждого объекта — "DT" (значение из проекта) или "RT" (переопределено во время выполнения).

Поведение и ограничения

Структура ответа отличается от старой справки: вместо плоского объекта messageArchiveSettings каждое значение обёрнуто в {value, source}, добавлено statisticsCountingPeriod, а поле базы называется dbName.

Если SecurityRoot не найден или архив не настроен — OpcUa_BadNotFound с errorText.