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

Обновление настройки идентификации активов

Запрос

Тип Метод
PUT /asset_lookup_confs/update

Описание: при выполнении запроса будет обновлена информация о настройке в соответствии с заданными параметрами.

Работает по принципу частичного обновления, т.е. будут обновлены только те поля модели, которые были переданы в запросе.

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

PUT
http://127.0.0.1/cruddy/v2/asset_lookup_confs/update

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

Параметр Тип Обязательность Описание
id string Required Идентификатор настройки
name string Required Название настройки
ranges Array<string> Required Диапазоны IP-адресов. Маски подсетей в CIDR-нотации.

При создании/изменении можно указать IP-адрес вместо CIDR
strategy string Required Стратегия идентификации актива:
- ip;
- fqdn;
- mac
Пример тела запроса

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "ranges": [
    "string"
  ],
  "strategy": "ip"
}

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

Статус код: 200 – успешное обновление информации о настройке.

Формат: JSON.

Тело ответа: модель обновленной настройки.

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "name": "string",
  "ranges": [
    "string"
  ],
  "strategy": "ip",
  "_relations": {}
}

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

Код Ответ Описание
400 1. Bad Request
2. missing uid header
3. Pgr-User-Id should be uuid format
4. empty name
5. exceeded maximum length for a value
6. empty strategy
7. invalid strategy …
8. empty ranges
9. invalid range format
1. Неверный тип параметра запроса, либо отсутствует обязательный параметр
2. Не передан заголовок Pgr-User-ID
3. Недопустимый формат Pgr-User-ID
4. Поле name не может быть пустым
5. Превышена максимальная длина поля name
6. Поле strategy не может быть пустым
7. Недопустимое значение поля strategy
8. Поле ranges не может быть пустым
9. Недопустимое значение в массиве ranges
404 Not Found Редактируемый объект не найден в БД
409 name_already_used Попытка создать объект с существующим уникальным атрибутом
500 Internal Server Error Другие ошибки при редактировании объекта

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

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

Код 400

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

Код 404

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

Код 409

{
  "error": "name_already_used",
  "error_code": 409,
  "extra": {
    "fields": [
      "name"
    ]
  }
}

Код 500

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