カスタム ヘッダーを定義する

Media CDN では、カスタム リクエスト ヘッダーとカスタム レスポンス ヘッダーを指定できます。

カスタム ヘッダーを使用すると、次のことができます。

• 国、リージョン、都市など、クライアントに関する地理データを返し、ローカライズされたコンテンツの表示に使用できます。
• レスポンスがキャッシュから提供されているかどうか（全体または一部）と、レスポンスを送信するキャッシュのロケーションを決定します。
• リクエスト ヘッダーとレスポンス ヘッダーの両方を削除、置換、または追加します。

カスタム ヘッダーを設定する

ヘッダーは各ルートで設定されるため、マニフェストや動画セグメントなどのさまざまなコンテンツのヘッダーを追加、削除できます。

CDN 処理パスの早い段階で、キャッシュ保存の決定前に、ルートごとのカスタム リクエスト ヘッダーを設定します。たとえば、cache-control ヘッダーをルートごとのカスタム ヘッダーとして設定すると、CDN のキャッシュ保存動作に影響します。

デフォルトでは、追加されたヘッダー値はカンマ区切りで、同じフィールド名を持つレスポンス ヘッダーまたはリクエスト ヘッダーに追加されます。

既存の値を上書きするには、replace を true に設定します。

gcloud edge-cache services describe prod-media-service

routeRules:
- priority: 1
   description: "video routes"
   matchRules:
      - prefixMatch: "/video/"
   headerAction:
      responseHeadersToAdd:
      # Return the country (or region) associated with the client's IP address.
      - headerName: "client-geo"
         headerValue: "{client_region}"
         replace: true
      requestHeadersToAdd:
      # Inform the upstream origin server the request is from Media CDN
      - headerName: "x-downstream-cdn"
         headerValue: "Media CDN"
      responseHeadersToRemove:
      - headerName: "X-User-ID"
      - headerName: "X-Other-Internal-Header"

route_rule {
  description = "video routes"
  priority    = 1
  match_rule {
    prefix_match = "/video/"
  }
  origin = google_network_services_edge_cache_origin.default.name
  header_action {
    response_header_to_add {
      # Return the country (or region) associated with the client's IP address.
      header_name  = "client-geo"
      header_value = "{client_region}"
      replace      = true
    }
    request_header_to_add {
      # Inform the upstream origin server that the request is from Media CDN.
      header_name  = "x-downstream-cdn"
      header_value = "Media CDN"
    }
    response_header_to_remove {
      header_name = "X-User-ID"
    }
    response_header_to_remove {
      header_name = "X-Other-Internal-Header"
    }
  }
}

この例では、次の操作を行います。

• {client_region} 変数を使用してレスポンスにカスタム client-geo ヘッダーを追加します。これは、クライアントの IP アドレスに関連付けられた国（またはリージョン）を返します。
• 静的文字列を使用して、リクエストにカスタム x-downstream-cdn ヘッダーを追加します。
• 2 つの内部ヘッダーを削除します。

送信元固有のカスタム ヘッダーを構成するには、送信元固有のホストの書き換えまたはヘッダーの変更を構成するをご覧ください。

動的ヘッダー変数

カスタム ヘッダーには 1 つ以上の動的変数を含めることができます。

キャッシュキー ポリシー（cacheKeyPolicy.includedHeaderNames）の一部であるリクエスト ヘッダーには、1 つ以上のカスタム変数を含めることができます。他の動的変数を含むリクエスト ヘッダーは、キャッシュキーの一部にできません。

カスタム変数には次の考慮事項が適用されます。

• 既存のリクエスト ヘッダーとレスポンス ヘッダーは保持されますが、次のものは削除されます。

  • X-User-IP
  • X-Google または X-GFE を含む任意のヘッダー

• ヘッダーの鍵と値は、RFC 7230 に準拠している必要があります。旧式の形式は許可されません。

• すべてのヘッダーキーは小文字です（HTTP/2 を遵守）。

• 一部のヘッダーは統合されます。同じヘッダーキー（例: Via）を持つ複数のインスタンスがある場合は、ロードバランサはそれらの値を 1 つのヘッダーキーを持つ、1 つのカンマ区切りのリストにまとめます。値をカンマ区切りのリストで表すことができるヘッダーのみが統合されます。 その他のヘッダー（Set-Cookie など）が結合されることはありません。

• いくつかのヘッダーが追加されるか、値が追加されます。 Media CDN は、X-Forwarded-For などの特定のヘッダーを常に追加、または変更します。

• Media CDN は、クライアントや送信元で設定されていたとしても、サポートされている変数を含む任意のレスポンス ヘッダーを展開します。これにより、カスタム ヘッダーの構成に加えて、クライアント（動画プレーヤーなど）または送信元のインフラストラクチャから動的ヘッダーを設定できます。

• たとえば、前述のルールに従って、X-Goog- ヘッダーと X-Amz- ヘッダーは保持され、小文字になります。

キャッシュ ステータスの値

{cdn_cache_status} ヘッダー変数は、レスポンスを提供したキャッシュの階層に対応する複数の値を返すことができます。{cdn_cache_status} ヘッダー変数を解釈する際は、次のガイドラインを考慮してください。

• ヘッダーに hit が含まれている場合、リクエストされたコンテンツはキャッシュから取得されています。
• ヘッダーに miss が含まれている場合、リクエストされたコンテンツはキャッシュノードで見つからなかったため、アップストリーム ノードから取得する必要がありました。
• ヘッダーに fetch が含まれている場合、リクエストされたコンテンツはオリジンから取得されています。

• ヘッダーに uncacheable が含まれている場合、リクエストされたコンテンツは、キャッシュ インフラストラクチャの一部またはすべてのコンポーネントでキャッシュ不可とみなされています。

  • ヘッダーに hit または miss も含まれている場合、リクエストされたコンテンツは、一部のキャッシュ コンポーネントではキャッシュ不可、他のコンポーネントではキャッシュ可能とみなされています。
  • ヘッダーに hit または miss も含まれていない場合、リクエストされたコンテンツは、すべてのキャッシュ コンポーネントでキャッシュ不可とみなされ、このコンテンツに対するすべてのリクエストは送信元から取得されます。コンテンツが適切にキャッシュに保存されるようにするには、Media CDN の送信元の要件を確認してください。

デフォルトのヘッダー

Media CDN は、それぞれ次のリクエスト ヘッダーとレスポンス ヘッダーをオリジン リクエストとクライアント レスポンスに追加します。

ヘッダーキーは小文字で大文字と小文字を区別しないため、リクエスト ヘッダーとレスポンス ヘッダーの両方で小文字が指定されます。

エッジのポイント オブ プレゼンス（PoP）のロケーションやキャッシュ ステータス（hit、miss など）など、その他のヘッダーは、動的ヘッダー変数を使用して追加できます。