Управлять шаблоном страницы ответа
Изменить шаблон
-
В консоли управления
выберите каталог с шаблоном. -
Перейдите
в сервис Smart Web Security. -
На панели слева выберите
Шаблоны ответов. -
В строке с нужным шаблоном нажмите
→ Редактировать. -
В открывшемся окне измените параметры:
-
Имя страницы.
-
Описание.
-
Код ответа — HTTP-код
, который будет возвращаться клиенту при использовании шаблона. -
Формат ответа:
HTML,JSON,XMLилиCustom.Форматам
HTML,JSONиXMLсоответствуют значения HTTP-заголовка Content-Type :text/html,application/jsonиapplication/xml.Чтобы указать другое значение, выберите
Customи измените Content-Type. -
Чтобы добавить HTTP-заголовок, нажмите Добавить заголовок ответа и укажите его Ключ (название заголовка) и Значение. Для одного шаблона можно добавить не более десяти заголовков. Не добавляйте
Content-TypeиContent-Length: значениеContent-Typeзадается при выборе формата ответа.Чтобы удалить заголовок, нажмите
напротив его строки. -
Тело ответа — измените содержимое страницы, которое будет возвращено клиенту. Размер тела ответа не должен превышать 2 КБ, а содержимое должно соответствовать выбранному формату.
-
Добавьте или удалите из тела ответа пресеты — дополнительные параметры, которые могут передаваться клиенту на странице ответа.
-
-
Нажмите Сохранить.
Чтобы посмотреть предварительный вид страницы ответа, на странице шаблона нажмите
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.
-
Посмотрите описание команды изменения шаблона:
yc smartwebsecurity custom-page custom-page update --help -
Измените нужные параметры. Например, чтобы заменить тело ответа и его формат, выполните команду:
yc smartwebsecurity custom-page custom-page update \ --id <идентификатор_шаблона> \ --content '{"message":"Доступ ограничен. Обратитесь в поддержку: support@example.com."}' \ --content-type application/jsonГде:
--id— идентификатор шаблона. Обязательный параметр.--content— новое тело ответа размером не более 2 КБ.--content-type— значение HTTP-заголовкаContent-Type, соответствующее формату тела ответа.
Укажите только параметры, которые нужно изменить: CLI автоматически сформирует маску обновления. Остальные параметры сохранятся. Описания параметров шаблона приведены в инструкции по созданию.
Воспользуйтесь методом REST API update для ресурса CustomPage или вызовом gRPC API CustomPageService/Update.
Передайте идентификатор шаблона в customPageId (в gRPC — custom_page_id) и новые значения полей. Перечислите изменяемые поля в маске обновления: updateMask для REST API или update_mask для gRPC API. Например, чтобы изменить только тело ответа, передайте новое значение content и включите content в маску.
Важно
Без маски обновления неуказанные поля будут сброшены к значениям по умолчанию.
Получить информацию о шаблоне
- В консоли управления
выберите каталог с шаблоном. - Перейдите
в сервис Smart Web Security. - На панели слева выберите
Шаблоны ответов. - Выберите нужный шаблон.
- На странице Обзор отобразится подробная информация о шаблоне.
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.
-
Посмотрите описание команд получения списка шаблонов и информации об отдельном шаблоне:
yc smartwebsecurity custom-page custom-page list --help yc smartwebsecurity custom-page custom-page get --help -
Получите список шаблонов в каталоге:
yc smartwebsecurity custom-page custom-page list \ --folder-id <идентификатор_каталога>--folder-id— идентификатор каталога с шаблонами. Можно не указывать, если каталог задан в профиле CLI. -
Получите информацию о нужном шаблоне, указав его идентификатор из списка:
yc smartwebsecurity custom-page custom-page get \ --id <идентификатор_шаблона>--id— идентификатор шаблона. Вместо него можно указать имя шаблона в параметре--name.
- Чтобы получить список шаблонов в каталоге, воспользуйтесь методом REST API list для ресурса CustomPage или вызовом gRPC API CustomPageService/List. Передайте идентификатор каталога в
folderId(в gRPC —folder_id). - Чтобы получить информацию об отдельном шаблоне, воспользуйтесь методом REST API get для ресурса CustomPage или вызовом gRPC API CustomPageService/Get. Передайте идентификатор шаблона в
customPageId(в gRPC —custom_page_id).
Удалить шаблон
Перед удалением замените шаблон в профилях безопасности, профилях ARL и их правилах, где он используется. Пока шаблон добавлен в профиль или правило, удалить его нельзя.
-
В консоли управления
выберите каталог с шаблоном. -
Перейдите
в сервис Smart Web Security. -
На панели слева выберите
Шаблоны ответов. -
В строке с нужным шаблоном нажмите
→ Удалить.Если шаблон еще используется, при попытке удаления появится список объектов с этим шаблоном. Перейдите в настройки каждого объекта и выберите другой шаблон.
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.
-
Посмотрите описание команды удаления шаблона:
yc smartwebsecurity custom-page custom-page delete --help -
Удалите шаблон:
yc smartwebsecurity custom-page custom-page delete \ --id <идентификатор_шаблона>--id— идентификатор шаблона. Вместо него можно указать имя шаблона в параметре--name.
Воспользуйтесь методом REST API delete для ресурса CustomPage или вызовом gRPC API CustomPageService/Delete. Передайте идентификатор шаблона в customPageId (в gRPC — custom_page_id).