Changes between Initial Version and Version 1 of ApiAlarms


Ignore:
Timestamp:
Aug 13, 2017, 1:06:36 AM (7 years ago)
Author:
alx
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ApiAlarms

    v1 v1  
     1=  Команда alarms  =
     2
     3== Назначение команды ==
     4
     5Команда `alarms` возвращает список текущих аварий блока MC04-DSL-3U.
     6
     7== Ключи запроса ==
     8
     9||  '''Ключ'''  ||  '''Тип значения'''  ||  '''обязательный'''  ||  '''Описание'''  ||
     10||  cmd  ||  строка  ||  да  || "alarms" - имя команды ||
     11
     12=== Пример запроса ===
     13
     14 `{"cmd":"alarms"}`
     15
     16== Права доступа ==
     17
     18Для выполнения команды `alarms` не требуется наличия каких-либо прав.
     19
     20== Возвращаемые данные ==
     21
     22В случае успешного выполнения команда `alarms` возвращает ключ `alarms`, значением которого является массив объектов (хэшей), каждый из которых описывает одну аварию. Каждый объект содержит следующие ключи:
     23
     24||  '''Ключ'''  ||  '''Тип значения'''  ||  '''Описание'''  ||
     25||  slot  ||  число  || номер слота, в котором возникла авария ||
     26||  oid  ||  строка  || идентификатор аварии (oid переменной платы) ||
     27||  start  ||  число  || время начала аварии (UNIX time) ||
     28||  prio  ||  число  || приоритет аварии: 1 - срочная, 2 и более - не срочная ||
     29||  name  ||  строка  || текстовое описание аварии ||
     30||  confirmed  ||  логический  || значение true означает, что авария подтверждена пользователем ||
     31
     32Пример ответа:
     33
     34{{{
     35{
     36  "cmd":"alarms",
     37  "alarms":[
     38    {
     39      "confirmed":false,
     40      "slot":2,
     41      "oid":".7.2.1.0",
     42      "prio":1,
     43      "start":1367822543,
     44      "name":"port 2: LOS (Loss of signal)"
     45    }
     46  ]
     47}
     48}}}