URLリダイレクトパラメータ

URLリダイレクトには、ソースURL、ターゲットURL、ステータスコード、およびURLマッチング動作とランタイム動作に影響を与える追加のパラメータがあります。

URLリダイレクトパラメータは以下の通りです：

• ソースURL (String)

  • APIフィールド名: source_url。
  • リダイレクトが適用されるために、受信リクエストURLが一致しなければならないURL文字列。このプロパティは必須です。ソースURLの最大長は32 KBです。
  • 値は有効なURLでなければなりませんが、URLスキームは必須ではありません（例: https）；スキームが省略された場合、リダイレクトはhttpおよびhttpsの両方のURLスキームに適用されます。
  • バルクリダイレクトリストには、正確に同じソースURLを持つ複数のURLリダイレクトを含めることはできません。
  • 受信リクエストをリダイレクトのソースURLと一致させるURLマッチングアルゴリズムの正確な動作は、サブドメインを含めるおよびサブパスマッチングパラメータの値に依存します。
  • サポートされているURLコンポーネントの詳細については、サポートされているURLコンポーネントを参照してください。

• ターゲットURL (String)

  • APIフィールド名: target_url。
  • URLリダイレクトの一致がある場合にクライアントがリダイレクトされるURL。このプロパティは必須です。ターゲットURLの最大長は32 KBです。
  • 値は有効なURLでなければなりません。最終的なターゲットURLは、クエリ文字列を保持するおよびパスサフィックスを保持するパラメータの値に依存します。
  • サポートされているURLコンポーネントの詳細については、サポートされているURLコンポーネントを参照してください。

• サブパスマッチング (Boolean)

  • APIフィールド名: subpath_matching。
  • trueの場合、現在のリダイレクトは、現在のURLリダイレクトに一致するかどうかを判断する際にリクエストURLにサブパスマッチングアルゴリズムを適用します。デフォルト値はfalseです。
  • 例えば、サブパスマッチングが有効な状態で/my-folder/から/other-folder/へのURLリダイレクトは、/my-folder/itemから/other-folder/itemへのリクエストもリダイレクトします。ただし、パスサフィックスを保持するがtrueの場合のみ、リダイレクトにはitem部分が含まれます。詳細についてはパスサフィックスを保持するを参照してください。
  • 詳細については、リダイレクトのソースURLのマッチングを参照してください。

• サブドメインを含める (Boolean)

  • APIフィールド名: include_subdomains。
  • trueの場合、ソースURLのホスト名はすべてのサブドメインにも適用されます — リダイレクトは、ソースURLのドメイン部分の左側にあるすべてのサブドメインと指定されたドメインに対して一致します。デフォルト値はfalseです。
  • 例えば、ソースURLがhttp://example.com/aboutとして定義されたリダイレクトは、http://a.example.com/aboutやhttp://a.b.example.com/aboutのリクエストにも適用されます。
  • 詳細については、リダイレクトのソースURLのマッチングを参照してください。

• クエリ文字列を保持する (Boolean)

  • APIフィールド名: preserve_query_string。
  • trueの場合、リダイレクトURLは元のリクエストのクエリ文字列を保持します。デフォルト値はfalseです。
  • 例えば、クエリ文字列を保持するが有効な状態で/my-folder/から/other-folder/へのURLリダイレクトは、/my-folder/?name=valueから/other-folder/?name=valueへのリクエストをリダイレクトします。クエリ文字列を保持するが無効な場合、リクエストは/my-folder/?name=valueから/other-folder/にリダイレクトされます。

• パスサフィックスを保持する (Boolean)

  • APIフィールド名: preserve_path_suffix。
  • サブパスマッチングが有効な場合のみ適用されます。trueの場合、リダイレクトURLはソースURLの残りの（一致しない）パス要素を含むことを定義します。デフォルト値はtrueです。
  • 例えば、サブパスマッチングとパスサフィックスを保持するの両方が有効な場合、/my-folder/から/another-folder/へのURLリダイレクトは、/my-folder/fooから/another-folder/fooへの受信リクエストをリダイレクトします。パスサフィックスを保持するが無効な場合、同じリクエストはURLリダイレクトに一致しますが、/my-folder/fooから/another-folder/にリダイレクトされます。

• ステータスコード (Integer)

  • APIフィールド名: status_code。
  • リダイレクト時にクライアントに返されるHTTPステータスコード。デフォルト値は301です。
  • 値は以下のいずれかでなければなりません: 301（恒久的に移動）、302（見つかりました、一時的に移動とも呼ばれる）、307（一時的リダイレクト）、または308（恒久的リダイレクト）。