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

Редактирование набора правил в формате JSON

JSON-редактор позволяет просматривать и изменять содержимое существующего Набора правил обработки запросов. Он предназначен для пользователей, знакомых с JSON и структурой Правил обработки запросов.

Визуальный редактор и JSON-редактор — два представления одного Набора правил обработки запросов. Изменения, сохранённые в одном редакторе, отображаются в другом.

Создать новый Набор правил обработки запросов в JSON-редакторе нельзя. Сначала создайте Набор правил обработки запросов в визуальном редакторе.

Необходимые условия для выполнения процедуры

Сервисы в составе Аккаунта:

Права доступа вашей учетной записи пользователя:

  • Настройки сервисов
    • Редактирование: JSON можно просматривать и изменять
    • Просмотр: JSON доступен только для чтения. Редактирование недоступно, кнопка сохранения и окно Проверка на ошибки не отображаются

Откройте Набор правил обработки запросов в формате JSON

  1. Перейдите в NGENIX Multidesk на страницу Аккаунт → Обработка запросов → Наборы правил обработки запросов
  2. Откройте Набор правил обработки запросов одним из способов:
    1. откройте и переключитесь из визуального редактора в JSON-редактор
    2. раскройте строку Набора правил обработки запросов и выберите Редактировать в JSON

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

Измените Набор правил обработки запросов

JSON содержит состояние Набора правил обработки запросов в поле enabled и массив Правил обработки запросов в поле rules.

В JSON-редакторе можно:

  • включить (выключить) Набор правил обработки запросов
  • создать, изменить, удалить, включить (выключить) Правило обработки запросов
  • изменить порядок Правил обработки запросов в массиве rules. Этот порядок определяет последовательность их применения

Допускается удаление всех Правил обработки запросов и сохранение Набора правил обработки запросов с пустым массивом:

Код

{
  "enabled": true,
  "rules": []
}

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

Создайте Правило обработки запросов

Добавьте новый объект в массив rules без поля id:

Код

{
  "name": "Белый список IP",
  "enabled": true,
  "conditions": [
    {
      "variable": "ip.addr",
      "function": "inList",
      "listId": 1007158
    }
  ],
  "actions": [
    {
      "action": "allow"
    }
  ]
}

После сохранения Платформа присвоит Правилу обработки запросов идентификатор. Поле id появится в JSON без обновления страницы.

Не задавайте новому Правилу обработки запросов поле id, в том числе со значением 0, null, пустой строкой или произвольным идентификатором

Не изменяйте id существующего Правила обработки запросов

Если заменить значение id, Правило обработки запросов не пройдет проверку. Если удалить поле id и сохранить изменения, Правило обработки запросов будет создано заново с новым идентификатором, при этом его положение в Наборе правил обработки запросов сохранится.

Проверьте JSON и сохраните изменения

JSON-редактор предлагает допустимые поля, условия, действия и другие значения. Чтобы открыть список вариантов, введите кавычки и выберите нужное значение.

Редактор также проверяет обязательные поля. Например, для пустого объекта {} в окне Проверка на ошибки появятся сообщения:

Код

Поле enabled является обязательным
Поле name является обязательным
Поле conditions является обязательным
Поле actions является обязательным

Сообщение содержит позицию ошибки в JSON.

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

Обнаруженные проблемы отображаются в окне Проверка на ошибки. Если ошибок нет, окно остается пустым.

Сохранить изменения можно, если JSON изменён и ошибок нет.

Учитывайте формат JSON

Редактор работает со стандартным JSON и не поддерживает комментарии. Для отступов используются два пробела (tabSize = 2).

При открытии и после сохранения JSON автоматически форматируется редактором NGENIX. Пользовательское форматирование не сохраняется и не влияет на работу Набора правил обработки запросов.

Переключайтесь между редакторами

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

При переходе в другой раздел NGENIX Multidesk или другом способе ухода со страницы предупреждение не появляется. Несохранённые изменения будут потеряны.

Ограничения

Индивидуальные настройки Bot Detection

JSON-редактор недоступен, если Набор обработки запросов содержит хотя бы одно Правило с индивидуальными настройками сервиса Bot Detection. В этом случае:

  • в списке Наборов правил обработки запросов нет действия Редактировать в JSON
  • на странице Набора правил обработки запросов нельзя переключиться в JSON-редактор
  • содержимое такого Правила обработки запросов нельзя просмотреть в визуальном редакторе. Вместо него отображается отметка "Правило содержит индивидуальные настройки сервиса Bot Detection"

Других условий, ограничивающих доступ к JSON-редактору, нет.

Количество Правил обработки запросов

Для JSON-редактора нет отдельного ограничения на количество Правил обработки запросов. Применяется общий лимит, указанный в разделе Технические ограничения.