← Правила Cloudflare / rules / custom-errors / reference

Параметры Custom Errors

Пользовательские правила ошибок определяют, когда срабатывает пользовательская ошибка и какое содержимое показывается посетителям. Параметры правила указаны ниже:

Имя API: N/A (обрабатывается через asset_name и content_type параметры)

Тип содержимого встроенного ответа, отправляемого посетителю сайта (JSON, HTML, Text или XML), или Пользовательский ресурс ошибки при отправке содержимого пользовательского ресурса ошибки.

При использовании API необходимо задать либо asset_name либо задайте оба content_type и content параметры. См. Ответ JSON / Ответ HTML / Текстовый ответ / Ответ XML.

Имя API: status_code Integer Необязательно

Код состояния HTTP для ответа. Если значение указано, оно заменит текущий код состояния ответа.

Код состояния должен находиться в диапазоне от 400 и 999.

Имя API: asset_name String Необязательно

Имя ресурс пользовательской ошибки который вы ранее загрузили (в панели управления можно создать ресурс при создании правила). Ресурс может включать токены ошибок которые будут заменены реальными значениями перед отправкой страницы с ошибкой посетителю.

Custom error rule может ссылаться только на ресурс, определенный в той же области, что и само правило (то есть в той же зоне или учетной записи).

В панели управления этот параметр доступен только при выборе Custom error asset в Тип ответа.

При использовании API необходимо указать либо asset_name или content параметр.

Имена API: content String Необязательно и content_type String Обязательный

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

Необходимо указать либо asset_name или content параметр.

Максимальный размер содержимого составляет 10 КБ.

При использовании API необходимо также задать content_type параметр, который определяет тип содержимого возвращаемого ответа. Значение должно быть одним из следующих:

• text/html
• text/plain
• application/json
• text/xml

ресурс пользовательской ошибки соответствует веб-ресурсу, например HTML-странице (включая все связанные изображения, CSS и код JavaScript), который Cloudflare получает и сохраняет на основе указанного вами URL, чтобы показывать его посетителям как страницу ошибки.

Пользовательские ресурсы ошибок имеют следующие параметры:

Имя API: name String Обязательный

Имя пользовательского ресурса ошибки. Пример значения: "500_error_template".

Имя ресурса может содержать следующие символы:

• Заглавные и строчные буквы (A-Z и a-z)
• Числа (0-9)
• Символ подчеркивания (_) символ

Максимальная длина составляет 200 символов.

Имя API: description String Необязательно

Строка с описанием custom error asset. Пример значения: "Standard 5xx error template page".

Имя API: url String Обязательный

URL страницы, которую Cloudflare должен получить и сохранить, чтобы позже показывать её посетителям в качестве страницы ошибки согласно настроенным правила пользовательской ошибки. Пример значения: "https://example.com/errors/500.html".

При создании или обновлении ресурса с указанием URL Cloudflare собирает все изображения, CSS и код JavaScript, используемые на странице, минифицирует содержимое и сохраняет его у себя.

Содержимое страницы по указанному URL может включать токены ошибок которые будут заменены реальными значениями перед отправкой страницы с ошибкой посетителю.

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

При использовании API, если вы обновляете ресурс и указываете тот же URL, Cloudflare заново загружает этот URL вместе с его ресурсами и сохраняет их у себя.

Максимальный размер ресурса составляет 1.5 МБ.