定义自定义标头

借助媒体 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 标头。
• 移除了两个内部标头。

如需配置特定于来源的自定义标头，请参阅配置特定于来源的主机重写或标头修改。

动态标头变量

自定义标头可以包含一个或多个动态变量。

属于缓存键政策 (cacheKeyPolicy.includedHeaderNames) 的请求标头可以包含一个或多个自定义变量。包含其他动态变量的请求标头不能作为缓存键的一部分。

以下注意事项适用于自定义变量：

• 系统会保留现有的请求和响应标头，但会移除以下标头：

  • X-User-IP
  • 包含 X-Google 或 X-GFE 的任何标头

• 标头键和值必须符合 RFC 7230，不允许使用已过时的格式。

• 所有标头键都会转换为小写（根据 HTTP/2）。

• 某些标头会合并。如果同一标头键（例如 Via）具有多个实例，则负载均衡器会将它们的值组合成单个标头键的单一英文逗号分隔列表。只有其值可以用英文逗号分隔列表来表示的标头会合并。 Set-Cookie 之类的其他标头永远不会合并。

• 系统会添加一些标头，或者为一些标头附加值。 Media CDN 始终会添加或修改某些标头，例如 X-Forwarded-For。

• Media CDN 会展开包含受支持变量的任何响应标头，即使该标头是由客户端或源站设置的也是如此。这样一来，除了配置自定义标头之外，您还可以从客户端（例如视频播放器）或源基础架构设置动态标头。Media CDN 不会展开请求路径上的变量。

• 例如，根据前面所述的规则，X-Goog- 和 X-Amz- 标头会被保留并转换为小写。

缓存状态值

{cdn_cache_status} 标头变量可以返回与提供响应的缓存层级对应的多个值。在解读 {cdn_cache_status} 标头变量时，请考虑以下准则：

• 如果标头包含 hit，则表示所请求的内容是从缓存中检索的。
• 如果标头包含 miss，则表示在缓存节点中未找到所请求的内容，必须从上游节点检索。
• 如果标头包含 fetch，则表示所请求的内容是从来源检索的。

• 如果标头包含 uncacheable，则缓存基础架构的某些或所有组件认为所请求的内容不可缓存。

  • 如果标头还包含 hit 或 miss，则表示某些缓存组件认为所请求的内容不可缓存，而其他缓存组件认为可缓存。
  • 如果该标头不包含 hit 或 miss，则所有缓存组件都认为所请求的内容不可缓存，并且对该内容的所有请求都从源中提取。为确保您的内容得到适当缓存，请查看媒体 CDN 源站要求。

默认标头

Media CDN 会分别向源请求和客户端响应添加以下请求标头和响应标头。

由于标头键不区分大小写，因此请求和响应标头的标头键都会转换为小写。

您可以使用动态标头变量添加其他标头，包括边缘 PoP 位置和缓存状态（例如 hit 和 miss）。