Перейти к основному содержимому

POST /v2/sync

Ресурс Networks представляет собой введенную нами абстракцию, которая позволяет определять группы IP-адресов или подсетей, доступных для управления Host Based NGFW. Эти подсети затем могут быть связаны с конкретными группами безопасности для логического разделения и использоваться в правилах для разрешения или блокирования доступа к определенным ресурсам в вашей сети.

Более подробно по организации БД можно посмотреть здесь.

Входные параметры​

  • networks.networks[] - Массив/Список подсетей типа IP.
  • networks.networks[].name - Название подсети.
  • networks.networks[].network - Объект содержащий CIDR подсети
  • networks.networks[].network.CIDR - Подсеть типа IP.
  • syncOp - Поле определяющее действие с данными из запроса.
названиеобязательностьтип данныхзначение по умолчанию
networks[]даObject[]
networks[].nameдаString
networks[].networkдаObject
networks[].network.CIDRдаString
syncOpдаEnum("Delete", "Upsert", "FullSync")

Ограничения

  • networks.networks[].name:

    • Значение не может быть пустым.
    • Длина значения поля не должна превышать 256 символов.
    • Значение поля должно начинаться и заканчиваться символами без пробелов.
    • Значение должно быть уникальным в рамках типа ресурса.

  • networks.networks[].network.CIDR:

    • Значение не может быть пустым.
    • Значение поля должно начинаться и заканчиваться символами без пробелов.
    • В пределах одной Security Group и направления трафика (I/E) диапазоны адресов подсетей могут пересекаться, присутствует auto-merge.
    • Подсеть должна соответствовать формату записи, определенному в RFC 4632.

Пример использования

curl '127.0.0.1:9007/v2/sync' \
  --header 'Content-Type: application/json' \
  --data '{
    "networks": {
      "networks": [
        {
          "name": "nw-1",
          "network": {
            "CIDR": "10.0.0.0/24"
          }
        }
      ]
    },
    "syncOp": "Upsert"
  }'

Выходные параметры

названиетип данныхописание
-Objectв случае успеха возвращается пустое тело

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

Пользователь указал некорректные значения агрументов
  • HTTP code: 400
  • gRPC code: INVALID_ARGUMENT
  • gRPC number: 3
Не найден метод
  • HTTP code: 404
  • gRPC code: NOT_FOUND
  • gRPC number: 5
Ошибка в указанных данных
  • HTTP code: 500
  • gRPC code: INTERNAL
  • gRPC number: 13

Диаграмма последовательности