自定义错误规则定义何时触发自定义错误,以及向访问者提供的内容。规则参数如下:
API 名称:N/A(通过 asset_name 和 content_type 参数处理)
发送给网站访问者的内联响应内容类型(JSON、HTML、Text 或 XML),或者在发送自定义错误资产内容时选择 Custom error asset(自定义错误资产)。
使用 API 时,你必须设置 asset_name,或者同时设置 content_type 和 content 参数。请参阅 JSON / HTML / Text / XML 响应。
API 名称:status_code IntegerOptional
响应的 HTTP 状态码。如果提供,此值将覆盖当前响应状态码。
状态码必须介于 400 和 999 之间。
API 名称:asset_name StringOptional
你之前上传的自定义错误资产的名称(在仪表板中,你可以在创建规则时创建资产)。资产可能包含错误令牌,这些令牌在将错误响应发送给访问者之前会替换为实际值。
自定义错误规则只能引用与规则在同一范围(即同一 zone 或账户)中定义的资产。
在仪表板中,仅当你在 Response type(响应类型) 中选择 Custom error asset 时,此参数才可用。
使用 API 时,你必须提供 asset_name 或 content 参数。
API 名称:content StringOptional 和 content_type StringRequired
要返回的响应正文。它可以包含错误令牌,这些令牌在将错误响应发送给访问者之前会替换为实际值。
你必须提供 asset_name 或 content 参数。
最大内容大小为 10 KB。
使用 API 时,你还必须设置 content_type 参数,它定义返回响应的内容类型。值必须是以下之一:
text/htmltext/plainapplication/jsontext/xml
自定义错误资产对应于一个 Web 资源,例如 HTML 网页(包括任何引用的图像、CSS 和 JavaScript 代码)。Cloudflare 会根据你提供的 URL 获取并保存该资源,以便作为错误页面提供给访问者。
自定义错误资产具有以下参数:
API 名称:name StringRequired
自定义错误资产的名称。示例值:"500_error_template"。
资产名称可以包含以下字符:
- 大写和小写字母(
A-Z和a-z) - 数字(
0-9) - 下划线(
_)字符
最大长度为 200 个字符。
API 名称:description StringOptional
描述自定义错误资产的字符串。示例值:"Standard 5xx error template page"。
API 名称:url StringRequired
你希望 Cloudflare 获取并存储的页面 URL,以便稍后根据配置的自定义错误规则作为错误页面提供给访问者。示例值:"https://example.com/errors/500.html"。
当你创建或更新资产并提供 URL 时,Cloudflare 会收集页面中使用的任何图像、CSS 和 JavaScript 代码,压缩内容并在内部保存。
指定 URL 处的页面内容可能包含错误令牌,这些令牌在将错误响应发送给访问者之前会替换为实际值。
使用仪表板时,你可以稍后再次触发获取,以获取页面及其资源的最新版本,并在内部存储。
使用 API 时,如果你更新资产并提供相同的 URL,Cloudflare 将再次获取该 URL 及其资源,并在内部存储。
最大资产大小为 1.5 MB。