/Methods/GetISLogSettings

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > События и сообщения >

/Methods/GetISLogSettings

Возвращает пользовательские настройки отображения, предупреждения и экспорта журнала сообщений ИБ.

HTTP: POST /Methods/GetISLogSettings

Запрос

{
  "sessionId": 123456789
}

Поля запроса

Поле

Тип

Обязательное

Описание

sessionId

integer

условно

Нужен, если сессия не передана заголовком Session-Id

Других полей обработчик не читает.

Ответ

{
  "limit": 1000,
  "exportSettings": {
    "exportNameFormat": "{Name}_{yyyy}-{MM}-{dd}-{HH}_{mm}_{ss}",
    "logCleanupExportPath": "/ISEventsBackup/"
  },
  "warningSetting": 90,
  "serverTime": 1710000000123,
  "code": 0
}

Поля ответа

Поле

Тип

Описание

limit

integer

Ограничение числа сообщений в пользовательском журнале; по умолчанию 1000

exportSettings

object

Настройки экспорта при очистке журнала

exportSettings.exportNameFormat

string

Шаблон имени CSV; по умолчанию {Name}_{yyyy}-{MM}-{dd}-{HH}_{mm}_{ss}

exportSettings.logCleanupExportPath

string

Каталог экспорта относительно каталога проекта; по умолчанию /ISEventsBackup/

warningSetting

integer

Порог предупреждения о заполнении журнала, процентов; по умолчанию 90

serverTime

integer

Время сервера, Unix time в миллисекундах

code

integer

0 при успешном чтении

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

Метод требует право ViewISLog. Если проверка прав не настроена или доступ запрещён, errorText содержит конкретную причину.

Настройки читаются из is_log_settings.json в каталоге проекта. При отсутствии или ошибке разбора файла возвращаются значения по умолчанию.

Метод не возвращает параметры подключения и ограничения архива сообщений. Старая схема messageArchiveSettings не соответствует текущему обработчику; архивные настройки обслуживают отдельные методы GetISEventsArchiveSettings, SetISEventsArchiveSettings и RestoreISEventsArchiveSettings.

В текущем пути ошибки проверки прав вспомогательная функция записывает подробный code, но возвращает общий OpcUa_Bad; затем общая оболочка может добавить второй корневой code с общим значением. Клиенту при таком отказе следует учитывать errorText, а не полагаться на первый одноимённый ключ.