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

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

Запрос

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

Описание: При выполнении запроса будет выполнено сканирование аппаратного обеспечения на активе. Использует IP сетевого интерфейса актива (первый в базе, если несколько).

Создаёт/обновляет hardware_informations в БД, удаляет старые данные.

Возвращает ID сетевого интерфейса и его актуальное аппаратное обеспечение.

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

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

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

Параметр Тип Обязательность Описание
assetId string Required ID актива
credentialId string Required ID учетной записи сборка данных
type string Required Тип подключения. Допустимые значения:
- ssh
- rpc
- wmi
Пример тела запроса

{
  "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",
  "type": "ssh"
}

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

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

Формат: JSON.

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

Параметр Тип данных Описание
networkInterfaceId string ID сетевого интерфейса
hardwareInfo Array<HardwareInformation> Массив аппаратного обеспечения
Пример ответа

{
  "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 1. Bad Request
2. credential id is empty
3. asset id is empty
4. type is empty
5. asset id should be uuid format
6. credential id should be uuid format
7. invalid type
8. network interfaces not found
1. Неверный тип параметра запроса, либо отсутствует обязательный параметр
2. Учетная запись не задана
3. Актив не задан
4. Тип подключения не задан
5. Недопустимый формат assetId
6. Недопустимый формат credentialId
7. Недопустимое значение поля type
8. Не найдены сетевые интерфейсы для переданного актива
404 service asset not found
credential not found
Актив не найден
Учетная запись не найдена
500 Internal Server Error Другие ошибки при удалении объектов

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

Пример ответа
Код 400

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

Код 404

{
  "error": "Not Found",
  "error_code": 404
}

Код 500

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