INTEGRITY Документация

Объекты JSON

На этой странице приведены примеры объектов JSON, используемых в API Programmable Flow Protection.

Программа

{
  "id": "31c70c65-9f81-4669-94ed-1e1e041e7b06",
  "name": "rate-limiter",
  "status": "success",
  "created_on": "2024-01-01T13:06:04.721954+01:00",
  "modified_on": "2024-01-01T13:06:04.721954+01:00"
}
Поле Описание
id Уникальный идентификатор программы.
name Имя программы, определяемое на основе имени загруженного файла.
status Статус компиляции и проверки. Один из success или failed. Программы с failed автоматически удаляются после 30 дней бездействия.
created_on Метка времени создания программы.
modified_on Метка времени последнего изменения программы.

Правило

{
  "id": "20b99eb6-8b48-48dd-a5b9-a995a0843b57",
  "program_id": "31c70c65-9f81-4669-94ed-1e1e041e7b06",
  "scope": "region",
  "name": "WEUR",
  "mode": "enabled",
  "expression": "ip.dst in { 192.0.2.0/24 }",
  "created_on": "2024-01-01T13:10:38.762503+01:00",
  "modified_on": "2024-01-01T13:10:38.762503+01:00"
}
Поле Описание
id Уникальный идентификатор правила.
program_id Идентификатор программы, которую выполняет это правило.
scope Область действия правила. Должна быть одной из global, region, или datacenter.
name Для global области действия используйте global. Для region или datacenter области действия укажите код региона или код дата-центра.
mode Режим правила. Должен быть одним из enabled, disabled, или monitoring.
expression Выражение языка правил чтобы отфильтровать пакеты, к которым применяется правило. Необязательно.
created_on Метка времени создания правила.
modified_on Метка времени последнего изменения правила.

Область действия

scope поле определяет, где выполняется правило:

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

Режим

mode поле определяет, как ведёт себя правило:

Выражение

expression поле представляет собой Выражение языка правил длиной до 8,192 символов. Выражение определяет, к каким пакетам применяется правило. Программа обрабатывает только пакеты, соответствующие этому выражению.

Поддерживаемые поля:

Если выражение пустое или не указано, правило применяется ко всем UDP-пакетам в пределах своей области действия.

Подробнее о настройках правил см. в Настройки правила.