5.5.1. 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.11.111/ctrl_api/v1/json \
   -H "Content-Type: application/json" \
   --data '{"user_id":4,"methods":[{"method":"AppList","params":{"project_id":23}}]}'

Ответ

 {
   "reply":[
     {
       "method":"AppList",
       "result":[
         {
           "app_id":537,
           "name":"CenOS pro probe",
           "alive":true
         },
         {
           "app_id":462,
           "name":"Experimental probe",
           "alive":true
         },
         {
           "app_id":461,
           "name":"IPTV edge",
           "alive":false
         }
       ]
     }
   ]
 }