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

Запрос

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

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

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


POST
http://127.0.0.1/cruddy/v2/sonar/hardware/mass-gather

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

Параметр	Тип данных	Обязательность	Описание
_	`Array`<EnrichmentInf>	Required	Данные обогащения

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


{
  "ip": "192.168.0.1",
  "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",
  "type": "ssh"
}

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

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

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

Параметр	Тип данных	Описание
_	`Array<object>`	Массив объектов
_{assetId}	`string`	Идентификатор актива
_{error}	`string`	Ошибка для данного актива
_{error_code}	`integer`	Код ошибки. Возможные варианты - 13004 — Не задан assetId - 13005 — Недопустимый формат assetId - 13006 — Не задан credentialId - 13007 — Недопустимый формат credentialId - 13008 — Не задан параметр type - 13009 — Недопустимое значение type - 13010 — Актив не найден - 13011 — Учетная запись не найдена - 11002 — Прочие ошибки
_{result}	`Array<HardwareInfoEnrichResult>`	Идентификатор интерфейса и его аппаратное обеспечение
_result{networkInterfaceId}	`string`	Идентификатор сетевого интерфейса
_result{hardwareInfo}	`Array`<HardwareInformation>	Массив аппаратного обеспечения

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


{
  "_": [
    {
      "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
      "error": "string",
      "error_code": 0,
      "result": {
        "networkInterfaceId": "29d425c3-7721-4ca1-9d9e-271f2746c0b6",
        "hardwareInfo": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "created_at": "2023-12-20T00:00:01.652259Z",
            "updated_at": "2023-12-20T00:00:01.652259Z",
            "service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
            "hardware_type": "string",
            "name": "string",
            "manufacturer": "string",
            "serial_number": "string",
            "additional_info": "string",
            "is_old": true,
            "service_asset": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "created_at": "2023-12-20T00:00:01.652259Z",
              "updated_at": "2023-12-20T00:00:01.652259Z",
              "type": "Host",
              "name": "Актив",
              "description": "Описание актива",
              "coordinates": "--- []",
              "active": true,
              "scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
              "value": 3,
              "client_note": "string",
              "internal_note": "string",
              "location": "string",
              "network_exposure": 3,
              "responsible_person": "string",
              "technical_specialist": "string",
              "responsible_group_id": "2d40d7ca-3218-4132-89ef-42e29379a567",
              "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c"
            }
          }
        ]
      }
    }
  ]
}

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

Код	Ответ	Описание
`400`	`Bad Request` `empty request`	Неверный тип параметра запроса, либо отсутствует обязательный параметр Пустой запрос или передан пустой массив
`500`	`Internal Server Error`	Другие ошибки при удалении объектов

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

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

   
Код 400   

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



   
Код 500   

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