4.3.12. AppList

Описание

Метод возвращает список запущенных и остановленных зондов проекта.

Запрос

{
  "user_id":(number),
  "methods":[
    {
      "method":"AppList",
      "params":{
        "project_id":(number),
        "app_status":(string),
      }
    }
  ]
}

где:

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

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

• app_status (опциональное поле) — строка, выводит следующую информацию:

  • active — запущенные зонды,

  • stopped — остановленные зонды,

  • all — значение по умолчанию, все зонды.

Ответ

{
  "reply":[
    {
      "method":"AppList",
      "result":[
        {
          "app_id":(number),
          "name":(string),
          "alive":(boolean)
        }
      ]
    }
  ]
}

где:

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

• name — строка, имя зонда;

• alive — логический тип, состояние зонда:

  • true — зонд запущен,

  • false — зонд остановлен.

Пример

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

curl http://172.16.1.41/ctrl_api/v1/json \
   -H "Content-Type: application/json" \
   --data '{"user_id":1,"methods":[{"method":"AppList","params":{"project_id":2}}]}'

Ответ

 {
   "reply": [
     {
       "method": "AppList",
       "result": [
         {
           "app_id": 1,
           "name": "Probe Ubuntu 20",
           "alive": true
         },
         {
           "app_id": 2,
           "name": "Probe Ubuntu 22",
           "alive": true
         }
       ]
     }
   ]
 }