Обновление метрик модулей агента

Запрос

Тип	Метод
POST	/agents/{id}/metrics

Описание: при выполнении запроса будут cохранены передаваемые метрики модулей агента по ID.

Пример запроса

POST
https://127.0.0.1:9000/cm/api/v2/agents/{id}/metrics

Path параметры запроса:

Параметр	Описание
{id}	Идентификатор агента сбора

Тело запроса:

stats - данные метрик модулей агента:

Параметр	Тип данных	Обязательность	Описание
agent_module_id	string	Required	ID профиля сбора
input	integer	Optional	Количество полученных сообщений
output	integer	Optional	Количество отправленных сообщений
last_input	string	Optional	Дата/Время получения последнего сообщения
last_output	string	Optional	Дата/Время отправки последнего сообщения
connection_state	string	Optional	Статус соединения с источником. Допустимые значения: - online - offline - error
state	string	Optional	Статус профиля сбора. Допустимые значения: - online - offline - error

Пример тела запроса

{
  "stats": [
    {
      "agent_module_id": "9eec13b8-cfc3-4114-963d-449bee939c9b",
      "input": 0,
      "output": 0,
      "last_input": "2019-08-24T14:15:22Z",
      "last_output": "2019-08-24T14:15:22Z",
      "connection_state": "online",
      "state": "online"
    }
  ]
}

Успешный ответ

Статус код: 200 - успешный ответ.

Формат: JSON.

Тело ответа:

Параметр	Тип	Описание
result	string	Результат выполнения

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

{
  "result": "OK"
}

Другие возможные ответы

Код	Ответ	Описание
400	Bad Request	Неверный тип параметра запроса, либо отсутствует обязательный параметр
401	no auth header	Не передан заголовок авторизации (PgrApiKey или Authorization)
404	not found	Объект не найден
500	Internal Server Error	Другие ошибки сервера

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

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

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 401

{
  "error": "no auth header"
  "error_code": 401
}

Код 404

{
  "error": "not found"
  "error_code": 404
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}