/Methods/GetEventsArchiveState

<< Click to Display Table of Contents >>

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

/Methods/GetEventsArchiveState

Возвращает состояние подключения и текущую заполненность архива событий с прогнозом переполнения.

Старая справка называла метод GetEventsArchiveFillState; фактически зарегистрирован маршрут GetEventsArchiveState.

HTTP: POST /Methods/GetEventsArchiveState

Право: не проверяется.

Запрос

{ "archiveId": 1 }

Поля запроса

Поле

Тип

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

По умолчанию

Описание

archiveId

integer

да

0

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

Ответ

{
  "errorConnectionText": "",
  "errorConnectionCode": 0,
  "currentArchiveSize": 536870912,
  "projectedArchiveOverflowDate": 1740000000000,
  "serverTime": 1710000000123,
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

errorConnectionText

string

успех

Текст ошибки соединения с БД (пустой при успехе)

errorConnectionCode

integer

успех

Код ошибки соединения (0 при успехе)

currentArchiveSize

integer

успех

Текущий размер архива (байт)

projectedArchiveOverflowDate

integer

есть записи и известно время первой

Прогноз переполнения, Unix time в мс

serverTime

integer

успех

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

code

integer

всегда

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

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

Несуществующий archiveIdOpcUa_BadInvalidArgument; нулевой максимальный размер архива — OpcUa_BadConfigurationError.

projectedArchiveOverflowDate отсутствует при пустом архиве; при уже достигнутом максимуме равен текущему времени.