Создать шаблон страницы ответа
-
В консоли управления
выберите каталог, в котором вы хотите создать шаблон. -
Перейдите
в сервис Smart Web Security. -
На панели слева выберите
Шаблоны ответов и нажмите Создать шаблон. -
Введите Имя страницы — имя шаблона.
Имя должно содержать от 1 до 50 символов: строчные и заглавные латинские буквы, цифры, дефисы, нижние подчеркивания и точки. Первый символ — буква или цифра.
-
(Опционально) Введите описание шаблона.
-
Выберите Код ответа — HTTP-код
, который будет возвращаться клиенту при использовании шаблона. -
Выберите Формат ответа:
HTML,JSON,XMLилиCustom.Форматам
HTML,JSONиXMLсоответствуют значения HTTP-заголовка Content-Type :text/html,application/jsonиapplication/xml. Чтобы указать другое значение, выберитеCustom. -
Для формата
Customвведите Content-Type. Например,text/plain. -
(Опционально) Чтобы добавить к ответу HTTP-заголовок, нажмите Добавить заголовок ответа и укажите параметры:
- Ключ — название HTTP-заголовка, например
Cache-Control. - Значение — значение заголовка, например
no-store, чтобы запретить кеширование ответа.
Можно добавить не более десяти заголовков. Не добавляйте заголовки
Content-TypeиContent-Length: значениеContent-Typeзадается при выборе формата ответа. - Ключ — название HTTP-заголовка, например
-
Введите Тело ответа — содержимое страницы, которое будет возвращено клиенту. Размер тела ответа не должен превышать 2 КБ.
Содержимое ответа должно соответствовать выбранному формату ответа, например:
-
HTML<!doctype html> <html lang="ru"> <head><meta charset="utf-8"><title>403 Forbidden</title></head> <body><h1>403 Forbidden</h1><p>Доступ ограничен.</p></body> </html> -
JSON{ "error": { "code": 403, "message": "Доступ ограничен.", "details": "Недостаточно прав для выполнения операции." } } -
XML<?xml version="1.0" encoding="UTF-8"?> <error> <code>403</code> <message>Доступ ограничен.</message> <details>Недостаточно прав для выполнения операции.</details> </error>
-
-
(Опционально) Добавьте в тело ответа дополнительные параметры, выбрав нужный пресет: ID запроса, IP-адрес, Время запроса.
Эти данные могут быть полезны, например, при обращении клиента в поддержку.
Пример страницы с дополнительными параметрами:
<!doctype html> <html lang="ru"> <head><meta charset="utf-8"><title>403 Forbidden</title></head> <body> <h1>403 Forbidden</h1> <p>Доступ ограничен. Если вы считаете блокировку ошибочной, передайте в поддержку следующие данные:</p> <p>Идентификатор запроса: %unique_key%</p> <p>IP-адрес: %client_ip%</p> <p>Время запроса: %request_time%</p> <p>Контакты: security@example.com</p> </body> </html> -
Нажмите Создать.
Чтобы посмотреть предварительный вид страницы ответа, на странице шаблона нажмите
Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.
По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.
Если вы обращаетесь к ресурсу по имени, поиск будет выполнен в каталоге по умолчанию. Если вы обращаетесь к ресурсу по идентификатору, поиск будет выполнен глобально — во всех каталогах с учетом прав доступа.
-
Посмотрите описание команды создания шаблона:
yc smartwebsecurity custom-page custom-page create --help -
Создайте шаблон. Например, чтобы возвращать HTML-страницу с кодом
403 Forbidden, выполните команду:yc smartwebsecurity custom-page custom-page create \ --folder-id <идентификатор_каталога> \ --name error.html \ --content '<!doctype html> <html lang="ru"> <head><meta charset="utf-8"><title>403 Forbidden</title></head> <body><h1>Доступ ограничен.</h1></body> </html>' \ --content-type text/html \ --status-code forbiddenГде:
--folder-id— идентификатор каталога, в котором будет создан шаблон. Можно не указывать, если каталог задан в профиле CLI.--name— имя шаблона.--content— тело ответа размером не более 2 КБ. Содержимое должно соответствовать формату, указанному в--content-type.--content-type— значение HTTP-заголовкаContent-Type, напримерtext/html,application/jsonилиtext/plain.--status-code— один из стандартных HTTP-кодов ответов . Укажите его имя в формате CLI: например,forbiddenдля403илиtoo-many-requestsдля429. Полный список допустимых значений приведен в описании параметра--status-codeв справочнике команды.
Дополнительно можно указать описание в
--description, метки ресурса в--labelsи не более десяти HTTP-заголовков ответа в--headers. Например,--headers Cache-Control=no-storeзапрещает кеширование ответа. ЗаголовокContent-Typeзадавайте через--content-type, аContent-Lengthне добавляйте.В теле ответа можно использовать динамические параметры: идентификатор запроса, IP-адрес клиента и время запроса.
Воспользуйтесь методом REST API create для ресурса CustomPage или вызовом gRPC API CustomPageService/Create.
В запросе передайте параметры шаблона:
folderId(в gRPC —folder_id) — идентификатор каталога. Обязательное поле.name— имя шаблона.content— тело ответа размером не более 2 КБ.contentType(в gRPC —content_type) — значение HTTP-заголовкаContent-Type, соответствующее формату тела ответа.statusCode(в gRPC —status_code) — HTTP-код ответа. Используйте значение перечисления, напримерFORBIDDENдля403илиTOO_MANY_REQUESTSдля429.
При необходимости добавьте описание в поле description, метки ресурса в labels и не более десяти HTTP-заголовков ответа в headers. Например, "headers": {"Cache-Control": "no-store"} запрещает кеширование ответа. Не добавляйте в headers заголовки Content-Type и Content-Length.
В теле ответа можно использовать динамические параметры: идентификатор запроса, IP-адрес клиента и время запроса.
Чтобы использовать созданный шаблон, добавьте его к профилю или правилу.