/Methods/GetState

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > JSON для HTTP-запросов > Описание JSON-запросов > Общие методы >

/Methods/GetState

GetState - запрос на получение информации об общем состоянии сервера. В запросе может быть передан sessionId, в этом случае возвращается информация о валидности данной сессии и дополнительная информация о ней.

Данные запроса

{"sessionId":<ID сессии>

}

Данные ответа

{"code":0, - в случае, если не задан sessionId или данная сессия не активна, возвращается ошибка OpcUa_BadSessionIdInvalid

"errorText":"", - текст ошибки в случае, если произошла ошибка старта задачи или визуализация в данном проекте отключена

"projectId":"", - текстовая строка, идентифицирующая текущую версию проекта. Меняется после каждой загрузки проекта на сервер

"projectSessionId":1, - число, идентифицирующее текущую запущенную сессию проекта, при каждом перезапуске изменяется

"currentOperator":"", - если в sessionId содержится ID активной сессии, то возвращается имя текущего оператора

"isMaster":true, - сервер в режиме MASTER (false - SLAVE)

"status":0, - биты состояния сервера. Возможные варианты:

LED_FAULT 0x1 - отказ сервера;

LED_ACTIVE_OUT 0x4 - сервер является мастером;

LED_ERROR 0x8 - ошибка сервера;

LED_RUNNING 0x10 - проект запущен.

 

]}

Пример ответа

{"code":0,"currentOperator":"sa"}

Алгоритм периодического контроля состояния сервера

После успешного логина запускается периодическая функция контроля состояния связи с сервером (период можно задавать отдельно в модели, по умолчанию 10 сек).

Если в ответе code = OpcUa_BadSessionIdInvalid, значит необходим вызов функции Login (текущая сессия недействительна).

Возможные ошибки

OpcUa_BadServiceUnsupported - визуализация недоступна в данном проекте (либо при старте конфигурации были ошибки). Текст ошибки будет передан через параметр errorText;

OpcUa_BadShutdown - идет перезагрузка проекта, необходимо выполнить запрос позже;

OpcUa_BadSessionIdInvalid - если не передан ID сессии или передан ID устаревшей сессии;

OpcUa_BadInternalError - при старте проекта возникла ошибка.

HTTP статус ответа всегда будет 200, даже если возвращается ненулевой code.