5.5.4. AppStoppedTasks

Описание

Список остановленных задач зонда и детальная информация о их настройках. Запрос осуществляется только для одного зонда. Для опроса следующего зонда повторите запрос.

Запрос

{
  "user_id":(number),
  "methods":[
    {
      "method":"AppStoppedTasks",
      "params":{
        "project_id":(number),
        "app_id":(number),
        "limit_value":(number),
        "page":(number)
      }
    }
  ]
}

• user_id - целое число, идентификатор пользователя;

• project_id - целое число, идентификатор проекта пользователя;

• app_id - целое число, идентификатор зонда;

• limit_value (опциональное поле) - целое число, максимальное количество проектов в ответе, позволяет разбивать результат на страницы. Значение по умолчанию 25;

• page (опциональное поле) - целое число, выбор страницы с результатом. Значение по умолчанию 1.

Ответ

{
  "reply":[
    {
      "method":"AppStoppedTasks",
      "result":{
        "app_id":(number),
        "page":(number),
        "limit_value":(number),
        "total_pages":(number),
        "stopped_tasks":[
          {
            "id":(number),
            "app_id":(number),
            "name":(string),
            "uri":(string),
            "start":(string),
            "start_f":(number),
            "status":(string),
            "end":(string),
            "end_f":(number),
            "profiles":{
              "alarm":[(number)],
              "email":[(number)],
              "threshold":[(number)],
              "pagerduty":[(number)],
              "record":[(number)],
              "snmp":[(number)],
              "webhook":[(number)],
              "telegram":[(number)],
              "kpi":[(number)]
            },
            "service":(string),
            "tags":(string),
            "config":{
              ...
            }
          }
        ]
      }
    }
  ]
}

• app_id - целое число, идентификатор зонда;

• page - целое число, отображаемая страница результата;

• limit_value - целое число, максимальное количество задач в ответе;

• total_pages - целое число, суммарное количество страниц результата при заданном limit_value;

• id - целое число, идентификатор задачи;

• app_id - целое число, идентификатор зонда;

• name - строка, имя потока (например, название канала);

• uri - строка, путь к анализируемому потоку (сервису, файлу);

• start - строка, дата и время создания задачи;

• start_f - вещественное число, дата создания задачи в формате Unix time с дробной частью (для увеличения точности отсчетов);

• status - строка, состояние задачи. Stopped - задача остановлена;

• end - строка, дата и время остановки задачи;

• end_f - вещественное число, дата остановки задачи в формате Unix time с дробной частью;

• profiles - объект, перечень идентификаторов профилей настроек системы оповещения, записи и доступности сервиса:

  • alarm - массив целых чисел, идентификатор профиля настроек триггеров Alarm оповещения. Текущая реализация позволяет задать только один профиль данного типа;

  • email - массив целых чисел, идентификаторы профилей настроек триггеров E-mail оповещения;

  • threshold - массив целых чисел, идентификатор профиля настроек и пороговых значений зонда. Текущая реализация позволяет задать только один профиль данного типа;

  • pagerduty - массив целых чисел, идентификаторы профилей настроек триггеров оповещения в систему PagerDuty;

  • record - массив целых чисел, идентификаторы профилей настроек записи;

  • snmp - массив целых чисел, идентификаторы профилей настроек триггеров SNMP оповещения;

  • webhook - массив целых чисел, идентификаторы профилей настроек триггеров Webhook оповещения;

  • telegram - массив целых чисел, идентификаторы профилей настроек триггеров оповещения в мессенджер Telegram;

  • kpi - массив целых чисел, идентификатор профиля настроек доступности сервиса. Текущая реализация позволяет задать только один профиль данного типа.

• service - строка, идентификационное имя сервиса (канала) для консолидации состояний и ошибок сервиса из разных точек мониторинга. Данное поле связывает задачи проекта от разных зондов на виде MosaicView;

• tags - строка, список тегов разделенный запятыми. Теги применяются для фильтрации отображения на различных видах;

• config - объект, настройки и дополнительная информация о задаче. Смотрите описание структуры в разделе Конфигурация задачи 1.

1

Структура конфигурации задачи получаемой в API запросе аналогична конфигурации хранящейся в файле monitor.cfg.

Пример

Запрос утилитой cURL

curl http://172.16.11.111/ctrl_api/v1/json \
   -H "Content-Type: application/json" \
   --data '{"user_id":4,"methods":[{"method":"AppStoppedTasks", "params":{"project_id":23,"app_id":702, "limit_value": 2, "page":1}}]}'

Часть ответа на запрос информации

{
  "reply":[
    {
      "method":"AppStoppedTasks",
      "result":{
        "app_id":702,
        "page":1,
        "limit_value":1,
        "total_pages":43,
        "stopped_tasks":[
          {
            "id":236701,
            "app_id":702,
            "name":"HD_HLS",
            "uri":"http://10.10.30.53:8080/BOROhd.m3u8",
            "start":"2020-02-27 21:47:15 +0700",
            "start_f":1582814835.807791,
            "status":"Stopped",
            "end":"2020-02-27 21:48:20 +0700",
            "end_f":1582814900.807791,
            "profiles":{
              "alarm":[
                79
              ],
              "email":[
                95
              ],
              "threshold":[
                98
              ]
            },
            "service":"HDchannel",
            "tags":"OTT,HLS,HD",
            "config":{
              ...
            }
          }
        ]
      }
    }
  ]
}