Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

カスタムエラーのパラメーター

最終更新 Markdown で表示Agent セットアップ

カスタムエラールール

カスタムエラールール は、カスタムエラーをいつ出すかと、訪問者に返す内容を決めます。ルールのパラメーターは次のとおりです。

レスポンスタイプ

API 名: N/Aasset_namecontent_type パラメーターで扱います)

訪問者へ返すインラインレスポンスのコンテンツタイプ(JSON、HTML、Text、または XML)です。カスタムエラーアセットの内容を返す場合は Custom error asset を選びます。

API を使うときは、asset_name を設定するか、content_typecontent の両方を設定する必要があります。JSON レスポンス / HTML レスポンス / Text レスポンス / XML レスポンス を参照してください。

レスポンスコード

API 名: status_code Integer 任意

レスポンスの HTTP ステータスコードです。指定した場合、現在のレスポンスステータスコードを上書きします。

ステータスコードは 400 から 999 の間である必要があります。

アセット

API 名: asset_name String 任意

あらかじめアップロードした カスタムエラーアセット の名前です(ダッシュボードでは、ルール作成時にアセットを作成できます)。アセットには エラートークン を含められ、訪問者へエラーレスポンスを返す前に実際の値へ置き換わります。

カスタムエラールールが参照できるアセットは、ルールと同じスコープ(同じゾーンまたはアカウント)で定義したものだけです。

ダッシュボードでは、Response typeCustom error asset を選んだときだけ、このパラメーターを使えます。

API を使うときは、asset_name または content のいずれかを指定する必要があります。

JSON レスポンス / HTML レスポンス / Text レスポンス / XML レスポンス

API 名: content String 任意 および content_type String 必須

返すレスポンス本文です。エラートークン を含められ、訪問者へエラーレスポンスを返す前に実際の値へ置き換わります。

asset_name または content のいずれかを指定する必要があります。

コンテンツの最大サイズは 10 KB です。

API を使うときは、返すレスポンスのコンテンツタイプを決める content_type パラメーターも設定する必要があります。値は次のいずれかです。

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

カスタムエラーアセット

カスタムエラーアセット は、HTML ページなどの Web リソースです(参照される画像、CSS、JavaScript を含みます)。指定した URL をもとに Cloudflare が取得して保存し、エラーページとして訪問者に返します。

カスタムエラーアセットのパラメーターは次のとおりです。

アセット名

API 名: name String 必須

カスタムエラーアセットの名前です。例: "500_error_template"

アセット名に使える文字は次のとおりです。

  • 英大文字と英小文字(A-Z および a-z
  • 数字(0-9
  • アンダースコア(_

最大長は 200 文字です。

説明

API 名: description String 任意

カスタムエラーアセットの説明文字列です。例: "Standard 5xx error template page"

アセットのアドレス

API 名: url String 必須

Cloudflare に取得・保存させ、設定した カスタムエラールール に従ってエラーページとして返すページの URL です。例: "https://example.com/errors/500.html"

アセットを作成または更新して URL を指定すると、Cloudflare はページで使われている画像、CSS、JavaScript を集め、コンテンツを圧縮して内部に保存します。

指定 URL のページ内容には エラートークン を含められ、訪問者へエラーレスポンスを返す前に実際の値へ置き換わります。

ダッシュボードでは、あとから再取得を実行して、ページとそのリソースの最新版を取り込み、内部に保存できます。

API を使う場合、アセットを更新して同じ URL を指定すると、Cloudflare はその URL とリソースを再度取得して内部に保存します。

アセットの最大サイズは 1.5 MB です。

役に立ちましたか?