Перейти к содержанию

Запуск обновления аппаратного обеспечения в фоновом режиме

Запрос

Тип Метод
POST /sonar/hardware/gather-start

Описание: метод запускает сканирование и обновление данных об аппаратном обеспечении актива в фоновом режиме.

Для выполнения операции необходимо передать информацию об активе, учётной записи и типе подключения.

Для запущенной операции создаётся объект фоновой задачи (async_job).

Функционал фоновой операции аналогичен методу обновления данных об аппаратном обеспечении.

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

POST

http://127.0.0.1/cruddy/v2/sonar/hardware/gather-start

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

Тело запроса соответствует структуре EnrichmentInfo.

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

{
  "<параметр>": "<значение>"
}

Примечание: Состав параметров тела запроса соответствует модели EnrichmentInfo, используемой методом обновления данных об аппаратном обеспечении.

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

Статус код: 200 – фоновое обновление аппаратного обеспечения успешно запущено.

Формат: JSON.

Параметры ответа:

Параметр Тип данных Описание
transaction_id string (uuid) ID созданной фоновой задачи
Пример ответа 

{
  "transaction_id": "5b2442b2-2e2c-47f7-9c9e-928fd26087af"
}

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

Код Ответ Описание
400 Bad Request Неверные параметры запроса
500 Internal Server Error Ошибка сервера

Возможные ошибки:

  • 400 — "missing uid header" — отсутствует заголовок Pgr-User-ID;
  • 400 — "Pgr-User-Id should be uuid format" — неверный формат Pgr-User-ID;
  • 400 — "Bad Request" — неверный тип параметра запроса либо отсутствует обязательный параметр;
  • 400 — "credential id is empty" — учётная запись не задана;
  • 400 — "asset id is empty" — актив не задан;
  • 400 — "type is empty" — тип подключения не задан;
  • 400 — "asset id should be uuid format" — недопустимый формат ID актива;
  • 400 — "credential id should be uuid format" — недопустимый формат ID учётной записи;
  • 400 — "invalid type" — недопустимое значение типа подключения;
  • 500 — "Internal Server Error" — ошибки сервера.
Пример ответа с кодом 400 

{
  "error": "asset id is empty"
}
Пример ответа с кодом 500 

{
  "error": "Internal Server Error"
}