google.cloud.gcp_compute_region_url_map 模块 – 创建 GCP RegionUrlMap

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 Playbook 中使用它，请指定：google.cloud.gcp_compute_region_url_map。

注意

由于违反了 Ansible 的包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。

概要

  • UrlMap 用于根据您为传入 URL 的主机和路径定义的规则将请求路由到后端服务。

要求

执行此模块的主机上需要满足以下要求。

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

如果凭据类型是 accesstoken，则为 OAuth2 访问令牌。

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

default_service

字典

如果没有任何 hostRules 匹配，则将流量定向到的 defaultService 资源的完整或部分 URL。如果另外指定了 defaultRouteAction，则在将请求发送到后端之前，会执行诸如 URL 重写等高级路由操作。但是，如果指定了 defaultService，则 defaultRouteAction 不能包含任何 weightedBackendServices。相反，如果 routeAction 指定了任何 weightedBackendServices，则不得指定 service。只能设置 defaultService、defaultUrlRedirect 或 defaultRouteAction.weightedBackendService 中的一个。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中包含键“selfLink”和资源 selfLink 的值。或者，您可以向 gcp_compute_region_backend_service 任务添加 `register: resource-name`，然后将此 default_service 字段设置为“{{ resource-name }}”

default_url_redirect

字典

当没有指定的 hostRules 匹配时，请求将重定向到由 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不得设置 defaultService 或 defaultRouteAction。

host_redirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

https_redirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxys 中使用的 UrlMaps 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

选择

  • false ← (默认)

  • true

path_redirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

prefix_redirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

redirect_response_code

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

一些有效选择包括：“FOUND”、“MOVED_PERMANENTLY_DEFAULT”、“PERMANENT_REDIRECT”、“SEE_OTHER”、“TEMPORARY_REDIRECT”

strip_query

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

选择

  • false ← (默认)

  • true

description

字符串

此资源的可选描述。创建资源时提供此属性。

env_type

字符串

指定您正在其中运行此模块的 Ansible 环境。

除非您清楚自己在做什么，否则不应设置此项。

此项仅更改任何 API 请求的 User Agent 字符串。

host_rules

列表 / 元素=字典

要针对 URL 使用的 HostRule 列表。

description

字符串

此 HostRule 的可选描述。创建资源时提供此属性。

hosts

列表 / 元素=字符串 / 必需

要匹配的主机模式列表。它们必须是有效的主机名，除了 * 将匹配任何字符串 ([a-z0-9-.]*)。在这种情况下，* 必须是第一个字符，并且在模式中必须后跟 - 或 .

path_matcher

字符串 / 必需

如果 hostRule 与 URL 的主机部分匹配，则用于匹配 URL 路径部分的 PathMatcher 的名称。

name

字符串 / 必需

资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

path_matchers

列表 / 元素=字典

要针对 URL 使用的已命名 PathMatcher 列表。

default_service

字典

对 RegionBackendService 资源的引用。如果 URL 的路径部分与此 PathMatcher 定义的任何 pathRules 都不匹配，则将使用此资源。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中包含键“selfLink”和资源 selfLink 的值。或者，您可以向 gcp_compute_region_backend_service 任务添加 `register: resource-name`，然后将此 default_service 字段设置为“{{ resource-name }}”

default_url_redirect

字典

当没有指定的 hostRules 匹配时，请求将重定向到由 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不得设置 defaultService 或 defaultRouteAction。

host_redirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

https_redirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxys 中使用的 UrlMaps 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

选择

  • false ← (默认)

  • true

path_redirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

prefix_redirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

redirect_response_code

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

一些有效选择包括：“FOUND”、“MOVED_PERMANENTLY_DEFAULT”、“PERMANENT_REDIRECT”、“SEE_OTHER”、“TEMPORARY_REDIRECT”

strip_query

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

选择

  • false ← (默认)

  • true

description

字符串

此资源的可选描述。

name

字符串 / 必需

HostRule 引用的此 PathMatcher 的名称。

path_rules

列表 / 元素=字典

路径规则列表。当只需要基于简单路径匹配的路由时，请使用此列表而不是 routeRules。指定路径规则的顺序无关紧要。匹配始终以最长路径优先的方式进行。例如：路径为 /a/b/c/* 的 pathRule 将在 /a/b/* 之前匹配，而与这些路径在此列表中出现的顺序无关。在给定的 pathMatcher 中，pathRules 或 routeRules 只能设置其中一个。

paths

列表 / 元素=字符串 / 必需

要匹配的路径模式列表。每个模式都必须以 / 开头，并且唯一允许使用 \ * 的位置是在 / 后面的末尾。馈送到路径匹配器的字符串不包括第一个 ? 或 # 之后的任何文本，并且此处不允许使用这些字符。

route_action

字典

为了响应匹配的路径，负载均衡器在将请求转发到所选后端之前，执行高级路由操作，例如 URL 重写、标头转换等。如果 routeAction 指定了任何 weightedBackendServices，则不得设置 service。相反，如果设置了 service，则 routeAction 不能包含任何 weightedBackendServices。routeAction 或 urlRedirect 只能设置其中一个。

cors_policy

字典

允许客户端跨域请求的规范。请参阅 W3C 跨域资源共享建议。

allow_credentials

布尔值

为了响应预检请求，将此项设置为 true 表示实际请求可以包含用户凭据。这会转换为 Access-Control-Allow-Credentials 标头。默认为 false。

选择

  • false ← (默认)

  • true

allow_headers

列表 / 元素=字符串

指定 Access-Control-Allow-Headers 标头的内容。

allow_methods

列表 / 元素=字符串

指定 Access-Control-Allow-Methods 标头的内容。

allow_origin_regexes

列表 / 元素=字符串

指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

allow_origins

列表 / 元素=字符串

指定允许执行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

disabled

布尔值 / 必需

如果为 true，则指定禁用 CORS 策略。

选择

  • false

  • true

expose_headers

列表 / 元素=字符串

指定 Access-Control-Expose-Headers 标头的内容。

max_age

整数

指定可以缓存预检请求结果的时间长度。这会转换为 Access-Control-Max-Age 标头的内容。

fault_injection_policy

字典

用于引入流量的故障注入规范，以测试客户端对后端服务故障的弹性。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定百分比的请求上引入延迟。同样，负载均衡器可以中止来自客户端的请求，以响应一定百分比的请求。配置了 fault_injection_policy 的客户端将忽略超时和 retry_policy。

abort

字典

有关如何中止作为故障注入一部分的客户端请求的规范。

http_status

整数 / 必需

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599 之间（包括 200 和 599）。

percentage

字符串 / 必需

作为故障注入一部分将被中止的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

delay

字典

有关如何延迟作为故障注入一部分的客户端请求，然后再将其发送到后端服务的规范。

fixed_delay

字典 / 必需

指定固定延迟间隔的值。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

percentage

字符串 / 必需

将作为故障注入一部分引入延迟的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

request_mirror_policy

字典

指定如何将路由的后端请求镜像到单独的镜像后端服务的策略。负载均衡器不等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头会添加 -shadow 后缀。

backend_service

字典 / 必需

要镜像到的 RegionBackendService 资源。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 backend_service 字段设置为“{{ name-of-resource }}”

retry_policy

字典

指定与此路由关联的重试策略。

num_retries

整数

指定允许的重试次数。此数字必须 > 0。

per_try_timeout

字典

指定每次重试尝试的非零超时。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

retry_conditions

列表 / 元素=字符串

指定应用此重试规则的一个或多个条件。有效值包括：- 5xx：如果后端服务以任何 5xx 响应代码响应，或者后端服务根本没有响应，例如：断开连接、重置、读取超时、连接失败和拒绝的流，则负载均衡器将尝试重试。

  • gateway-error：与 5xx 类似，但仅适用于响应代码 502、503 或 504。

  • connect-failure：负载均衡器将重试连接到后端服务失败的情况，例如，由于连接超时。

  • retriable-4xx：负载均衡器将重试可重试的 4xx 响应代码。

目前，唯一支持的可重试错误是 409。

  • refused-stream：如果后端服务使用 REFUSED_STREAM 错误代码重置流，则负载均衡器将重试。此重置类型表示可以安全地重试。

  • cancelled：如果响应标头中的 gRPC 状态代码设置为 cancelled，则负载均衡器将重试 - deadline-exceeded：如果响应标头中的 gRPC 状态代码设置为 deadline-exceeded，则负载均衡器将重试 - resource-exhausted：如果响应标头中的 gRPC 状态代码设置为 resource-exhausted，则负载均衡器将重试 - unavailable：如果响应标头中的 gRPC 状态代码设置为 unavailable，则负载均衡器将重试。

timeout

字典

指定所选路由的超时。超时是从请求完全处理（即流结束）到响应完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

url_rewrite

字典

用于修改请求 URL 的规范，然后再将请求转发到匹配的服务。

host_rewrite

字符串

在将请求转发到所选服务之前，请求的主机标头将替换为 hostRewrite 的内容。该值必须介于 1 和 255 个字符之间。

path_prefix_rewrite

字符串

在将请求转发到所选后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。该值必须介于 1 和 1024 个字符之间。

weighted_backend_services

列表 / 元素=字典

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流量流向其相应后端服务的比例。如果所有流量都需要流向单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。在标识后端服务并且将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作（如 URL 重写和标头转换）。

backend_service

字典 / 必需

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器会应用作为此 backendServiceWeight 一部分指定的任何相关 headerActions。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 backend_service 字段设置为“{{ name-of-resource }}”

header_action

字典

指定需要对所选 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。

request_headers_to_add

列表 / 元素=字典

在将请求转发到后端服务之前，添加到匹配请求的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

response_headers_to_add

列表 / 元素=字典

在将响应发送回客户端之前，添加到响应的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

response_headers_to_remove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

weight

整数 / 必需

指定发送到 backendService 的流量比例，计算方式为 weight / (routeAction 中所有 weightedBackendService 权重的总和)。仅针对新流量确定后端服务的选择。一旦用户的请求被定向到某个 backendService，后续请求将发送到相同的 backendService，由 BackendService 的会话亲和性策略决定。

该值必须介于 0 和 1000 之间。

service

字典

如果此规则匹配，则流量将定向到的区域后端服务资源。如果另外指定了 routeAction，则在将请求发送到后端之前，会生效高级路由操作（如 URL 重写等）。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。相反，如果 routeAction 指定了任何 weightedBackendService，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。 可以通过两种方式指定它。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。 或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 service 字段设置为“{{ name-of-resource }}”

url_redirect

字典

当路径模式匹配时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不得设置 service 或 routeAction。

host_redirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

https_redirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。

如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxy 中使用的 UrlMap 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

选择

  • false ← (默认)

  • true

path_redirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。

该值必须介于 1 和 1024 个字符之间。

prefix_redirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 和 1024 个字符之间。

redirect_response_code

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

一些有效选择包括：“FOUND”、“MOVED_PERMANENTLY_DEFAULT”、“PERMANENT_REDIRECT”、“SEE_OTHER”、“TEMPORARY_REDIRECT”

strip_query

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

选择

  • false ← (默认)

  • true

route_rules

列表 / 元素=字典

有序 HTTP 路由规则列表。当需要高级路由匹配和路由操作时，请使用此列表而不是 pathRules。指定 routeRules 的顺序很重要：第一个匹配的规则将使其指定的路由操作生效。在给定的 pathMatcher 中，只能设置 pathRules 或 routeRules 中的一个。UrlMap 中不支持为外部负载均衡器设置 routeRules。

header_action

字典

指定需要为所选后端服务生效的请求和响应标头的更改。此处指定的 headerAction 应用于匹配的 pathMatchers[].headerAction 之前，以及 pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction 之后。

request_headers_to_add

列表 / 元素=字典

在将请求转发到后端服务之前，添加到匹配请求的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

response_headers_to_add

列表 / 元素=字典

在将响应发送回客户端之前，添加到响应的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

response_headers_to_remove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

match_rules

列表 / 元素=字典

用于确定匹配的规则。

full_path_match

字符串

为了满足 matchRule 条件，请求的路径必须与 fullPathMatch 中指定的值完全匹配，删除原始 URL 中可能包含的任何查询参数和锚点。FullPathMatch 必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

header_matches

列表 / 元素=字典

指定标头匹配条件的列表，所有这些条件都必须与请求中相应的标头匹配。

exact_match

字符串

该值应与 exactMatch 的内容完全匹配。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

header_name

字符串 / 必需

要匹配的 HTTP 标头的名称。要与 HTTP 请求的授权进行匹配，请使用标头名称为“:authority”的 headerMatch。要匹配请求的方法，请使用标头名称“:method”。

invert_match

布尔值

如果设置为 false，则当满足上述匹配条件时，headerMatch 将被视为匹配。如果设置为 true，则当不满足上述匹配条件时，headerMatch 将被视为匹配。默认为 false。

选择

  • false ← (默认)

  • true

prefix_match

字符串

标头的值必须以 prefixMatch 的内容开头。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

present_match

布尔值

必须存在具有 headerName 内容的标头。无论请求的标头是否具有值，都会进行匹配。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

选择

  • false

  • true

range_match

字典

标头值必须为整数，且其值必须在 rangeMatch 中指定的范围内。如果标头不包含整数、数字或为空，则匹配失败。例如，对于范围 [-5, 0] * -3 将匹配 * 0 将不匹配 * 0.25 将不匹配 * -3someString 将不匹配。

只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

range_end

整数 / 必需

范围的末尾（不包括）。

range_start

整数 / 必需

范围的开头（包括）。

regex_match

字符串

标头的值必须与 regexMatch 中指定的正则表达式匹配。有关正则表达式语法，请参阅：en.cppreference.com/w/cpp/regex/ecmascript。要匹配 HTTP 请求中指定的端口，请使用 headerName 设置为 PORT 且正则表达式满足 RFC2616 Host 标头的端口说明符的 headerMatch。

只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

suffix_match

字符串

标头的值必须以 suffixMatch 的内容结尾。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

ignore_case

布尔值

指定 prefixMatch 和 fullPathMatch 匹配区分大小写。

默认为 false。

选择

  • false ← (默认)

  • true

metadata_filters

列表 / 元素=字典

负载均衡器使用的不透明筛选条件，用于将路由配置限制为一组有限的 xDS 兼容客户端。在向负载均衡器发送的 xDS 请求中，xDS 客户端会提供节点元数据。如果发生匹配，则相关的路由配置将提供给这些代理。对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则其所有 filterLabels 都必须与提供的元数据中的相应标签匹配。此处指定的 metadataFilters 可以覆盖引用此 UrlMap 的 ForwardingRule 中指定的 metadataFilters。metadataFilters 仅适用于将其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

filter_labels

list / elements=dictionary / required

基于 filterMatchCriteria 必须与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以包含 64 个条目。

name

字符串 / 必需

元数据标签的名称。名称的最大长度为 1024 个字符，且至少为 1 个字符。

value

字符串 / 必需

标签的值必须与指定的值匹配。value 的最大长度为 1024 个字符。

filter_match_criteria

字符串 / 必需

指定 filterLabels 列表中的单个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。支持的值为：* MATCH_ANY：至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。

* MATCH_ALL：所有 filterLabels 都必须在提供的元数据中具有匹配的标签。

一些有效选择包括：“MATCH_ALL”、“MATCH_ANY”

prefix_match

字符串

为了满足 matchRule 条件，请求的路径必须以指定的 prefixMatch 开头。prefixMatch 必须以 / 开头。该值必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

query_parameter_matches

列表 / 元素=字典

指定查询参数匹配条件的列表，所有这些条件都必须与请求中相应的查询参数匹配。

exact_match

字符串

如果参数的值与 exactMatch 的内容完全匹配，则 queryParameterMatch 匹配。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

name

字符串 / 必需

要匹配的查询参数的名称。查询参数必须存在于请求中，否则请求匹配将失败。

present_match

布尔值

指定如果请求包含查询参数，则 queryParameterMatch 匹配，无论该参数是否具有值。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

选择

  • false

  • true

regex_match

字符串

如果参数的值与 regexMatch 指定的正则表达式匹配，则 queryParameterMatch 匹配。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

regex_match

字符串

为了满足 matchRule 条件，删除原始 URL 提供的任何查询参数和锚点后，请求的路径必须满足 regexMatch 中指定的正则表达式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

priority

整数 / 必需

对于给定 pathMatcher 中的 routeRules，优先级决定了负载均衡器解释 routeRules 的顺序。routeRules 按优先级顺序进行评估，从最小的数字到最大的数字。规则的优先级随着其数字的增加而降低 (1、2、3、N+1)。应用与请求匹配的第一个规则。

不能配置两个或多个具有相同优先级的 routeRules。

每个规则的优先级必须设置为介于 0 和 2147483647 之间的数字（包括 0 和 2147483647）。

优先级数字可以有间隔，这使您可以在将来添加或删除规则，而不会影响其余规则。例如，1、2、3、4、5、9、12、16 是有效的优先级数字系列，您可以在将来向其中添加从 6 到 8、10 到 11 以及 13 到 15 编号的规则，而不会对现有规则产生任何影响。

route_action

字典

作为对匹配 matchRule 的响应，负载均衡器在将请求转发到所选后端之前执行高级路由操作，如 URL 重写、标头转换等。如果 routeAction 指定了任何 weightedBackendService，则不能设置 service。相反，如果设置了 service，则 routeAction 不能包含任何 weightedBackendService。只能设置 routeAction 或 urlRedirect 中的一个。

cors_policy

字典

允许客户端跨域请求的规范。请参阅 W3C 跨域资源共享建议。

allow_credentials

布尔值

为了响应预检请求，将此项设置为 true 表示实际请求可以包含用户凭据。这会转换为 Access-Control-Allow-Credentials 标头。默认为 false。

选择

  • false ← (默认)

  • true

allow_headers

列表 / 元素=字符串

指定 Access-Control-Allow-Headers 标头的内容。

allow_methods

列表 / 元素=字符串

指定 Access-Control-Allow-Methods 标头的内容。

allow_origin_regexes

列表 / 元素=字符串

指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

allow_origins

列表 / 元素=字符串

指定允许执行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

disabled

布尔值

如果为 true，则指定禁用 CORS 策略。

表示 CORS 策略正在生效。默认为 false。

选择

  • false ← (默认)

  • true

expose_headers

列表 / 元素=字符串

指定 Access-Control-Expose-Headers 标头的内容。

max_age

整数

指定可以缓存预检请求结果的时间长度。这会转换为 Access-Control-Max-Age 标头的内容。

fault_injection_policy

字典

用于引入流量的故障注入规范，以测试客户端对后端服务故障的弹性。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定百分比的请求上引入延迟。同样，负载均衡器可以中止来自客户端的请求，以响应一定百分比的请求。配置了 fault_injection_policy 的客户端将忽略超时和 retry_policy。

abort

字典

有关如何中止作为故障注入一部分的客户端请求的规范。

http_status

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599 之间（包括 200 和 599）。

percentage

字符串

作为故障注入一部分将被中止的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

delay

字典

有关如何延迟作为故障注入一部分的客户端请求，然后再将其发送到后端服务的规范。

fixed_delay

字典

指定固定延迟间隔的值。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

percentage

字符串

将作为故障注入一部分引入延迟的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

request_mirror_policy

字典

指定如何将路由的后端请求镜像到单独的镜像后端服务的策略。负载均衡器不等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头会添加 -shadow 后缀。

backend_service

字典 / 必需

要镜像到的 RegionBackendService 资源。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 backend_service 字段设置为“{{ name-of-resource }}”

retry_policy

字典

指定与此路由关联的重试策略。

num_retries

整数 / 必需

指定允许的重试次数。此数字必须 > 0。

per_try_timeout

字典

指定每次重试尝试的非零超时。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

retry_conditions

列表 / 元素=字符串

指定此重试规则适用时的一个或多个条件。有效值为：* 5xx：如果后端服务返回任何 5xx 响应代码，或者后端服务根本不响应（例如：断开连接、重置、读取超时、连接失败和拒绝的流），则负载均衡器将尝试重试。

* gateway-error：与 5xx 类似，但仅适用于响应代码 502、503 或 504。

* connect-failure：负载均衡器将在连接后端服务失败时重试，例如由于连接超时。

* retriable-4xx：负载均衡器将对可重试的 4xx 响应代码进行重试。

目前，唯一支持的可重试错误是 409。

* refused-stream：如果后端服务使用 REFUSED_STREAM 错误代码重置流，则负载均衡器将重试。此重置类型表示可以安全地重试。

* cancelled：如果响应头中的 gRPC 状态码设置为 cancelled，负载均衡器将重试。* deadline-exceeded：如果响应头中的 gRPC 状态码设置为 deadline-exceeded，负载均衡器将重试。* resource-exhausted：如果响应头中的 gRPC 状态码设置为 resource-exhausted，负载均衡器将重试。* unavailable：如果响应头中的 gRPC 状态码设置为 unavailable，负载均衡器将重试。

timeout

字典

指定所选路由的超时。超时是从请求完全处理（即流结束）到响应完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

seconds

字符串 / 必需

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

url_rewrite

字典

用于修改请求 URL 的规范，然后再将请求转发到匹配的服务。

host_rewrite

字符串

在将请求转发到所选服务之前，请求的主机标头将替换为 hostRewrite 的内容。该值必须介于 1 和 255 个字符之间。

path_prefix_rewrite

字符串

在将请求转发到所选后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。该值必须介于 1 和 1024 个字符之间。

weighted_backend_services

列表 / 元素=字典

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流量流向其相应后端服务的比例。如果所有流量都需要流向单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。在标识后端服务并且将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作（如 URL 重写和标头转换）。

backend_service

字典 / 必需

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器会应用作为此 backendServiceWeight 一部分指定的任何相关 headerActions。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 backend_service 字段设置为“{{ name-of-resource }}”

header_action

字典

指定需要对所选 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。

request_headers_to_add

列表 / 元素=字典

在将请求转发到后端服务之前，添加到匹配请求的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

response_headers_to_add

列表 / 元素=字典

在将响应发送回客户端之前，添加到响应的标头。

header_name

字符串 / 必需

标头的名称。

header_value

字符串 / 必需

要添加的标头的值。

replace

布尔值 / 必需

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

选择

  • false

  • true

response_headers_to_remove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

weight

整数 / 必需

指定发送到 backendService 的流量比例，计算方式为 weight / (routeAction 中所有 weightedBackendService 权重的总和)。仅针对新流量确定后端服务的选择。一旦用户的请求被定向到某个 backendService，后续请求将发送到相同的 backendService，由 BackendService 的会话亲和性策略决定。

该值必须介于 0 和 1000 之间。

service

字典

如果此规则匹配，则流量将定向到的区域后端服务资源。如果另外指定了 routeAction，则在将请求发送到后端之前，会生效高级路由操作（如 URL 重写等）。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。相反，如果 routeAction 指定了任何 weightedBackendService，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。 可以通过两种方式指定它。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。 或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 service 字段设置为“{{ name-of-resource }}”

url_redirect

字典

当此规则匹配时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不得设置 service 或 routeAction。

host_redirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

https_redirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。

如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxy 中使用的 UrlMap 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

选择

  • false ← (默认)

  • true

path_redirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。

该值必须介于 1 和 1024 个字符之间。

prefix_redirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 和 1024 个字符之间。

redirect_response_code

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

一些有效选择包括：“FOUND”、“MOVED_PERMANENTLY_DEFAULT”、“PERMANENT_REDIRECT”、“SEE_OTHER”、“TEMPORARY_REDIRECT”

strip_query

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。默认值为 false。

选择

  • false ← (默认)

  • true

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

对 URL 映射所在的区域的引用。

scopes

列表 / 元素=字符串

要使用的范围数组

service_account_contents

jsonarg

服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。

service_account_email

字符串

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。

service_account_file

path

如果选择了 serviceaccount 作为类型，则服务帐户 JSON 文件的路径。

state

字符串

给定对象是否应存在于 GCP 中

选择

  • "present" ←（默认）

  • "absent"

tests

列表 / 元素=字典

预期 URL 映射的列表。只有当所有测试用例都通过时，更新此 UrlMap 的请求才会成功。

description

字符串

此测试用例的描述。

host

字符串 / 必需

URL 的主机部分。

path

字符串 / 必需

URL 的路径部分。

service

字典 / 必需

对给定 URL 应映射到的预期 RegionBackendService 资源的引用。

此字段表示指向 GCP 中 RegionBackendService 资源的链接。 可以通过两种方式指定它。首先，您可以放置一个字典，其中键为“selfLink”，值为您的资源的 selfLink。 或者，您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务，然后将此 service 字段设置为“{{ name-of-resource }}”

示例

- name: create a health check
  google.cloud.gcp_compute_health_check:
    name: "{{ resource_name }}"
    type: HTTP
    http_health_check:
      port: 80
    check_interval_sec: 1
    timeout_sec: 1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a region backend service
  google.cloud.gcp_compute_region_backend_service:
    name: "{{ resource_name }}"
    region: us-central1
    health_checks:
    - "{{ healthcheck.selfLink }}"
    protocol: HTTP
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice

- name: create a region URL map
  google.cloud.gcp_compute_region_url_map:
    name: test_object
    region: us-central1
    default_service: "{{ backendservice }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

常见的返回值记录在此处：此处，以下是此模块特有的字段

键

描述

creationTimestamp

字符串

RFC3339 文本格式的创建时间戳。

返回：成功

defaultService

字典

如果没有任何 hostRules 匹配，则将流量定向到的 defaultService 资源的完整或部分 URL。如果另外指定了 defaultRouteAction，则在将请求发送到后端之前，会执行诸如 URL 重写等高级路由操作。但是，如果指定了 defaultService，则 defaultRouteAction 不能包含任何 weightedBackendServices。相反，如果 routeAction 指定了任何 weightedBackendServices，则不得指定 service。只能设置 defaultService、defaultUrlRedirect 或 defaultRouteAction.weightedBackendService 中的一个。

返回：成功

defaultUrlRedirect

complex

当没有指定的 hostRules 匹配时，请求将重定向到由 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不得设置 defaultService 或 defaultRouteAction。

返回：成功

hostRedirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

返回：成功

httpsRedirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxys 中使用的 UrlMaps 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

返回：成功

pathRedirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

返回：成功

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

返回：成功

redirectResponseCode

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

返回：成功

stripQuery

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

返回：成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

返回：成功

fingerprint

字符串

此资源的指纹。此字段在更新此资源期间在内部使用。

返回：成功

hostRules

complex

要针对 URL 使用的 HostRule 列表。

返回：成功

description

字符串

此 HostRule 的可选描述。创建资源时提供此属性。

返回：成功

hosts

列表 / 元素=字符串

要匹配的主机模式列表。它们必须是有效的主机名，除了 * 将匹配任何字符串 ([a-z0-9-.]*)。在这种情况下，* 必须是第一个字符，并且在模式中必须后跟 - 或 .

返回：成功

pathMatcher

字符串

如果 hostRule 与 URL 的主机部分匹配，则用于匹配 URL 路径部分的 PathMatcher 的名称。

返回：成功

id

整数

资源的唯一标识符。

返回：成功

name

字符串

资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

返回：成功

pathMatchers

complex

要针对 URL 使用的已命名 PathMatcher 列表。

返回：成功

defaultService

字典

对 RegionBackendService 资源的引用。如果 URL 的路径部分与此 PathMatcher 定义的任何 pathRules 都不匹配，则将使用此资源。

返回：成功

defaultUrlRedirect

complex

当没有指定的 hostRules 匹配时，请求将重定向到由 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不得设置 defaultService 或 defaultRouteAction。

返回：成功

hostRedirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

返回：成功

httpsRedirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxys 中使用的 UrlMaps 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

返回：成功

pathRedirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

返回：成功

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供其中一个或都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 到 1024 个字符之间。

返回：成功

redirectResponseCode

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

返回：成功

stripQuery

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

返回：成功

description

字符串

此资源的可选描述。

返回：成功

name

字符串

HostRule 引用的此 PathMatcher 的名称。

返回：成功

pathRules

complex

路径规则列表。当只需要基于简单路径匹配的路由时，请使用此列表而不是 routeRules。指定路径规则的顺序无关紧要。匹配始终以最长路径优先的方式进行。例如：路径为 /a/b/c/* 的 pathRule 将在 /a/b/* 之前匹配，而与这些路径在此列表中出现的顺序无关。在给定的 pathMatcher 中，pathRules 或 routeRules 只能设置其中一个。

返回：成功

paths

列表 / 元素=字符串

要匹配的路径模式列表。每个模式都必须以 / 开头，并且只允许在 / 之后的末尾使用 *。提供给路径匹配器的字符串不包括第一个 ? 或 # 之后的任何文本，并且此处不允许使用这些字符。

返回：成功

routeAction

complex

为了响应匹配的路径，负载均衡器在将请求转发到所选后端之前，执行高级路由操作，例如 URL 重写、标头转换等。如果 routeAction 指定了任何 weightedBackendServices，则不得设置 service。相反，如果设置了 service，则 routeAction 不能包含任何 weightedBackendServices。routeAction 或 urlRedirect 只能设置其中一个。

返回：成功

corsPolicy

complex

允许客户端跨域请求的规范。请参阅 W3C 跨域资源共享建议。

返回：成功

allowCredentials

布尔值

为了响应预检请求，将此项设置为 true 表示实际请求可以包含用户凭据。这会转换为 Access-Control-Allow-Credentials 标头。默认为 false。

返回：成功

allowHeaders

列表 / 元素=字符串

指定 Access-Control-Allow-Headers 标头的内容。

返回：成功

allowMethods

列表 / 元素=字符串

指定 Access-Control-Allow-Methods 标头的内容。

返回：成功

allowOriginRegexes

列表 / 元素=字符串

指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

返回：成功

allowOrigins

列表 / 元素=字符串

指定允许执行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

返回：成功

disabled

布尔值

如果为 true，则指定禁用 CORS 策略。

返回：成功

exposeHeaders

列表 / 元素=字符串

指定 Access-Control-Expose-Headers 标头的内容。

返回：成功

maxAge

整数

指定可以缓存预检请求结果的时间长度。这会转换为 Access-Control-Max-Age 标头的内容。

返回：成功

faultInjectionPolicy

complex

用于引入流量的故障注入规范，以测试客户端对后端服务故障的弹性。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定百分比的请求上引入延迟。同样，负载均衡器可以中止来自客户端的请求，以响应一定百分比的请求。配置了 fault_injection_policy 的客户端将忽略超时和 retry_policy。

返回：成功

abort

complex

有关如何中止作为故障注入一部分的客户端请求的规范。

返回：成功

httpStatus

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599 之间（包括 200 和 599）。

返回：成功

percentage

字符串

作为故障注入一部分将被中止的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

返回：成功

delay

complex

有关如何延迟作为故障注入一部分的客户端请求，然后再将其发送到后端服务的规范。

返回：成功

fixedDelay

complex

指定固定延迟间隔的值。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

percentage

字符串

将作为故障注入一部分引入延迟的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

返回：成功

requestMirrorPolicy

complex

指定如何将路由的后端请求镜像到单独的镜像后端服务的策略。负载均衡器不等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头会添加 -shadow 后缀。

返回：成功

backendService

字典

要镜像到的 RegionBackendService 资源。

返回：成功

retryPolicy

complex

指定与此路由关联的重试策略。

返回：成功

numRetries

整数

指定允许的重试次数。此数字必须 > 0。

返回：成功

perTryTimeout

complex

指定每次重试尝试的非零超时。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

retryConditions

列表 / 元素=字符串

指定应用此重试规则的一个或多个条件。有效值包括：- 5xx：如果后端服务以任何 5xx 响应代码响应，或者后端服务根本没有响应，例如：断开连接、重置、读取超时、连接失败和拒绝的流，则负载均衡器将尝试重试。

  • gateway-error：与 5xx 类似，但仅适用于响应代码 502、503 或 504。

  • connect-failure：负载均衡器将重试连接到后端服务失败的情况，例如，由于连接超时。

  • retriable-4xx：负载均衡器将重试可重试的 4xx 响应代码。

目前，唯一支持的可重试错误是 409。

  • refused-stream：如果后端服务使用 REFUSED_STREAM 错误代码重置流，则负载均衡器将重试。此重置类型表示可以安全地重试。

  • cancelled：如果响应标头中的 gRPC 状态代码设置为 cancelled，则负载均衡器将重试 - deadline-exceeded：如果响应标头中的 gRPC 状态代码设置为 deadline-exceeded，则负载均衡器将重试 - resource-exhausted：如果响应标头中的 gRPC 状态代码设置为 resource-exhausted，则负载均衡器将重试 - unavailable：如果响应标头中的 gRPC 状态代码设置为 unavailable，则负载均衡器将重试。

返回：成功

timeout

complex

指定所选路由的超时。超时是从请求完全处理（即流结束）到响应完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

urlRewrite

complex

用于修改请求 URL 的规范，然后再将请求转发到匹配的服务。

返回：成功

hostRewrite

字符串

在将请求转发到所选服务之前，请求的主机标头将替换为 hostRewrite 的内容。该值必须介于 1 和 255 个字符之间。

返回：成功

pathPrefixRewrite

字符串

在将请求转发到所选后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。该值必须介于 1 和 1024 个字符之间。

返回：成功

weightedBackendServices

complex

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流量流向其相应后端服务的比例。如果所有流量都需要流向单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。在标识后端服务并且将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作（如 URL 重写和标头转换）。

返回：成功

backendService

字典

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器会应用作为此 backendServiceWeight 一部分指定的任何相关 headerActions。

返回：成功

headerAction

complex

指定需要对所选 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。

返回：成功

requestHeadersToAdd

complex

在将请求转发到后端服务之前，添加到匹配请求的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

requestHeadersToRemove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

返回：成功

responseHeadersToAdd

complex

在将响应发送回客户端之前，添加到响应的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

responseHeadersToRemove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

返回：成功

weight

整数

指定发送到 backendService 的流量比例，计算方式为 weight / (routeAction 中所有 weightedBackendService 权重的总和)。仅针对新流量确定后端服务的选择。一旦用户的请求被定向到某个 backendService，后续请求将发送到相同的 backendService，由 BackendService 的会话亲和性策略决定。

该值必须介于 0 和 1000 之间。

返回：成功

service

字典

如果此规则匹配，则流量将定向到的区域后端服务资源。如果另外指定了 routeAction，则在将请求发送到后端之前，会生效高级路由操作（如 URL 重写等）。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。相反，如果 routeAction 指定了任何 weightedBackendService，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。

返回：成功

urlRedirect

complex

当路径模式匹配时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不得设置 service 或 routeAction。

返回：成功

hostRedirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

返回：成功

httpsRedirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。

如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxy 中使用的 UrlMap 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

返回：成功

pathRedirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。

该值必须介于 1 和 1024 个字符之间。

返回：成功

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 和 1024 个字符之间。

返回：成功

redirectResponseCode

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

返回：成功

stripQuery

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。

返回：成功

routeRules

complex

有序 HTTP 路由规则列表。当需要高级路由匹配和路由操作时，请使用此列表而不是 pathRules。指定 routeRules 的顺序很重要：第一个匹配的规则将使其指定的路由操作生效。在给定的 pathMatcher 中，只能设置 pathRules 或 routeRules 中的一个。UrlMap 中不支持为外部负载均衡器设置 routeRules。

返回：成功

headerAction

complex

指定需要为所选后端服务生效的请求和响应标头的更改。此处指定的 headerAction 应用于匹配的 pathMatchers[].headerAction 之前，以及 pathMatchers[].routeRules[].r outeAction.weightedBackendService.backendServiceWeightAction[].headerAction 之后。

返回：成功

requestHeadersToAdd

complex

在将请求转发到后端服务之前，添加到匹配请求的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

requestHeadersToRemove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

返回：成功

responseHeadersToAdd

complex

在将响应发送回客户端之前，添加到响应的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

responseHeadersToRemove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

返回：成功

matchRules

complex

用于确定匹配的规则。

返回：成功

fullPathMatch

字符串

为了满足 matchRule 条件，请求的路径必须与 fullPathMatch 中指定的值完全匹配，删除原始 URL 中可能包含的任何查询参数和锚点。FullPathMatch 必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

返回：成功

headerMatches

complex

指定标头匹配条件的列表，所有这些条件都必须与请求中相应的标头匹配。

返回：成功

exactMatch

字符串

该值应与 exactMatch 的内容完全匹配。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

headerName

字符串

要匹配的 HTTP 标头的名称。要与 HTTP 请求的授权进行匹配，请使用标头名称为“:authority”的 headerMatch。要匹配请求的方法，请使用标头名称“:method”。

返回：成功

invertMatch

布尔值

如果设置为 false，则当满足上述匹配条件时，headerMatch 将被视为匹配。如果设置为 true，则当不满足上述匹配条件时，headerMatch 将被视为匹配。默认为 false。

返回：成功

prefixMatch

字符串

标头的值必须以 prefixMatch 的内容开头。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

presentMatch

布尔值

必须存在具有 headerName 内容的标头。无论请求的标头是否具有值，都会进行匹配。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

rangeMatch

complex

标头值必须为整数，且其值必须在 rangeMatch 中指定的范围内。如果标头不包含整数、数字或为空，则匹配失败。例如，对于范围 [-5, 0] * -3 将匹配 * 0 将不匹配 * 0.25 将不匹配 * -3someString 将不匹配。

只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

rangeEnd

整数

范围的末尾（不包括）。

返回：成功

rangeStart

整数

范围的开头（包括）。

返回：成功

regexMatch

字符串

标头的值必须与 regexMatch 中指定的正则表达式匹配。有关正则表达式语法，请参阅：en.cppreference.com/w/cpp/regex/ecmascript。要匹配 HTTP 请求中指定的端口，请使用 headerName 设置为 PORT 且正则表达式满足 RFC2616 Host 标头的端口说明符的 headerMatch。

只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

suffixMatch

字符串

标头的值必须以 suffixMatch 的内容结尾。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。

返回：成功

ignoreCase

布尔值

指定 prefixMatch 和 fullPathMatch 匹配区分大小写。

默认为 false。

返回：成功

metadataFilters

complex

负载均衡器使用的不透明筛选条件，用于将路由配置限制为一组有限的 xDS 兼容客户端。在向负载均衡器发送的 xDS 请求中，xDS 客户端会提供节点元数据。如果发生匹配，则相关的路由配置将提供给这些代理。对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则其所有 filterLabels 都必须与提供的元数据中的相应标签匹配。此处指定的 metadataFilters 可以覆盖引用此 UrlMap 的 ForwardingRule 中指定的 metadataFilters。metadataFilters 仅适用于将其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

返回：成功

filterLabels

complex

基于 filterMatchCriteria 必须与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以包含 64 个条目。

返回：成功

name

字符串

元数据标签的名称。名称的最大长度为 1024 个字符，且至少为 1 个字符。

返回：成功

value

字符串

标签的值必须与指定的值匹配。value 的最大长度为 1024 个字符。

返回：成功

filterMatchCriteria

字符串

指定 filterLabels 列表中的单个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。支持的值为：* MATCH_ANY：至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。

* MATCH_ALL：所有 filterLabels 都必须在提供的元数据中具有匹配的标签。

返回：成功

prefixMatch

字符串

为了满足 matchRule 条件，请求的路径必须以指定的 prefixMatch 开头。prefixMatch 必须以 / 开头。该值必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

返回：成功

queryParameterMatches

complex

指定查询参数匹配条件的列表，所有这些条件都必须与请求中相应的查询参数匹配。

返回：成功

exactMatch

字符串

如果参数的值与 exactMatch 的内容完全匹配，则 queryParameterMatch 匹配。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

返回：成功

name

字符串

要匹配的查询参数的名称。查询参数必须存在于请求中，否则请求匹配将失败。

返回：成功

presentMatch

布尔值

指定如果请求包含查询参数，则 queryParameterMatch 匹配，无论该参数是否具有值。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

返回：成功

regexMatch

字符串

如果参数的值与 regexMatch 指定的正则表达式匹配，则 queryParameterMatch 匹配。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。

返回：成功

regexMatch

字符串

为了满足 matchRule 条件，删除原始 URL 提供的任何查询参数和锚点后，请求的路径必须满足 regexMatch 中指定的正则表达式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

返回：成功

priority

整数

对于给定 pathMatcher 中的 routeRules，优先级决定了负载均衡器解释 routeRules 的顺序。routeRules 按优先级顺序进行评估，从最小的数字到最大的数字。规则的优先级随着其数字的增加而降低 (1、2、3、N+1)。应用与请求匹配的第一个规则。

不能配置两个或多个具有相同优先级的 routeRules。

每个规则的优先级必须设置为介于 0 和 2147483647 之间的数字（包括 0 和 2147483647）。

优先级数字可以有间隔，这使您可以在将来添加或删除规则，而不会影响其余规则。例如，1、2、3、4、5、9、12、16 是有效的优先级数字系列，您可以在将来向其中添加从 6 到 8、10 到 11 以及 13 到 15 编号的规则，而不会对现有规则产生任何影响。

返回：成功

routeAction

complex

作为对匹配 matchRule 的响应，负载均衡器在将请求转发到所选后端之前执行高级路由操作，如 URL 重写、标头转换等。如果 routeAction 指定了任何 weightedBackendService，则不能设置 service。相反，如果设置了 service，则 routeAction 不能包含任何 weightedBackendService。只能设置 routeAction 或 urlRedirect 中的一个。

返回：成功

corsPolicy

complex

允许客户端跨域请求的规范。请参阅 W3C 跨域资源共享建议。

返回：成功

allowCredentials

布尔值

为了响应预检请求，将此项设置为 true 表示实际请求可以包含用户凭据。这会转换为 Access-Control-Allow-Credentials 标头。默认为 false。

返回：成功

allowHeaders

列表 / 元素=字符串

指定 Access-Control-Allow-Headers 标头的内容。

返回：成功

allowMethods

列表 / 元素=字符串

指定 Access-Control-Allow-Methods 标头的内容。

返回：成功

allowOriginRegexes

列表 / 元素=字符串

指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

返回：成功

allowOrigins

列表 / 元素=字符串

指定允许执行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。

返回：成功

disabled

布尔值

如果为 true，则指定禁用 CORS 策略。

表示 CORS 策略正在生效。默认为 false。

返回：成功

exposeHeaders

列表 / 元素=字符串

指定 Access-Control-Expose-Headers 标头的内容。

返回：成功

maxAge

整数

指定可以缓存预检请求结果的时间长度。这会转换为 Access-Control-Max-Age 标头的内容。

返回：成功

faultInjectionPolicy

complex

用于引入流量的故障注入规范，以测试客户端对后端服务故障的弹性。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定百分比的请求上引入延迟。同样，负载均衡器可以中止来自客户端的请求，以响应一定百分比的请求。配置了 fault_injection_policy 的客户端将忽略超时和 retry_policy。

返回：成功

abort

complex

有关如何中止作为故障注入一部分的客户端请求的规范。

返回：成功

httpStatus

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599 之间（包括 200 和 599）。

返回：成功

percentage

字符串

作为故障注入一部分将被中止的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

返回：成功

delay

complex

有关如何延迟作为故障注入一部分的客户端请求，然后再将其发送到后端服务的规范。

返回：成功

fixedDelay

complex

指定固定延迟间隔的值。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

percentage

字符串

将作为故障注入一部分引入延迟的流量（连接/操作/请求）的百分比。该值必须介于 0.0 和 100.0 之间（包括 0.0 和 100.0）。

返回：成功

requestMirrorPolicy

complex

指定如何将路由的后端请求镜像到单独的镜像后端服务的策略。负载均衡器不等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头会添加 -shadow 后缀。

返回：成功

backendService

字典

要镜像到的 RegionBackendService 资源。

返回：成功

retryPolicy

complex

指定与此路由关联的重试策略。

返回：成功

numRetries

整数

指定允许的重试次数。此数字必须 > 0。

返回：成功

perTryTimeout

complex

指定每次重试尝试的非零超时。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

retryConditions

列表 / 元素=字符串

指定此重试规则适用时的一个或多个条件。有效值为：* 5xx：如果后端服务返回任何 5xx 响应代码，或者后端服务根本不响应（例如：断开连接、重置、读取超时、连接失败和拒绝的流），则负载均衡器将尝试重试。

* gateway-error：与 5xx 类似，但仅适用于响应代码 502、503 或 504。

* connect-failure：负载均衡器将在连接后端服务失败时重试，例如由于连接超时。

* retriable-4xx：负载均衡器将对可重试的 4xx 响应代码进行重试。

目前，唯一支持的可重试错误是 409。

* refused-stream：如果后端服务使用 REFUSED_STREAM 错误代码重置流，则负载均衡器将重试。此重置类型表示可以安全地重试。

* cancelled：如果响应头中的 gRPC 状态码设置为 cancelled，负载均衡器将重试。* deadline-exceeded：如果响应头中的 gRPC 状态码设置为 deadline-exceeded，负载均衡器将重试。* resource-exhausted：如果响应头中的 gRPC 状态码设置为 resource-exhausted，负载均衡器将重试。* unavailable：如果响应头中的 gRPC 状态码设置为 unavailable，负载均衡器将重试。

返回：成功

timeout

complex

指定所选路由的超时。超时是从请求完全处理（即流结束）到响应完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。

返回：成功

nanos

整数

以纳秒分辨率表示的时间跨度，是秒的一小部分。小于一秒的持续时间用 0 `seconds` 字段和一个正 `nanos` 字段表示。必须介于 0 到 999,999,999 之间（包括 0 和 999,999,999）。

返回：成功

seconds

字符串

分辨率为秒的时间跨度。必须介于 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回：成功

urlRewrite

complex

用于修改请求 URL 的规范，然后再将请求转发到匹配的服务。

返回：成功

hostRewrite

字符串

在将请求转发到所选服务之前，请求的主机标头将替换为 hostRewrite 的内容。该值必须介于 1 和 255 个字符之间。

返回：成功

pathPrefixRewrite

字符串

在将请求转发到所选后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。该值必须介于 1 和 1024 个字符之间。

返回：成功

weightedBackendServices

complex

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流量流向其相应后端服务的比例。如果所有流量都需要流向单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。在标识后端服务并且将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作（如 URL 重写和标头转换）。

返回：成功

backendService

字典

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器会应用作为此 backendServiceWeight 一部分指定的任何相关 headerActions。

返回：成功

headerAction

complex

指定需要对所选 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。

返回：成功

requestHeadersToAdd

complex

在将请求转发到后端服务之前，添加到匹配请求的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

requestHeadersToRemove

列表 / 元素=字符串

在将请求转发到后端服务之前，需要从请求中删除的标头名称列表。

返回：成功

responseHeadersToAdd

complex

在将响应发送回客户端之前，添加到响应的标头。

返回：成功

headerName

字符串

标头的名称。

返回：成功

headerValue

字符串

要添加的标头的值。

返回：成功

replace

布尔值

如果为 false，则 headerValue 将附加到该标头已存在的任何值。如果为 true，则将为该标头设置 headerValue，并丢弃为该标头设置的任何值。

返回：成功

responseHeadersToRemove

列表 / 元素=字符串

在将响应发送回客户端之前，需要从响应中删除的标头名称列表。

返回：成功

weight

整数

指定发送到 backendService 的流量比例，计算方式为 weight / (routeAction 中所有 weightedBackendService 权重的总和)。仅针对新流量确定后端服务的选择。一旦用户的请求被定向到某个 backendService，后续请求将发送到相同的 backendService，由 BackendService 的会话亲和性策略决定。

该值必须介于 0 和 1000 之间。

返回：成功

service

字典

如果此规则匹配，则流量将定向到的区域后端服务资源。如果另外指定了 routeAction，则在将请求发送到后端之前，会生效高级路由操作（如 URL 重写等）。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。相反，如果 routeAction 指定了任何 weightedBackendService，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。

返回：成功

urlRedirect

complex

当此规则匹配时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不得设置 service 或 routeAction。

返回：成功

hostRedirect

字符串

将在重定向响应中使用的主机，而不是请求中提供的主机。该值必须介于 1 到 255 个字符之间。

返回：成功

httpsRedirect

布尔值

如果设置为 true，则重定向请求中的 URL 方案将设置为 https。

如果设置为 false，则重定向请求的 URL 方案将与请求的 URL 方案保持相同。这只能为 TargetHttpProxy 中使用的 UrlMap 设置。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。

返回：成功

pathRedirect

字符串

将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。

该值必须介于 1 和 1024 个字符之间。

返回：成功

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个，或者都不提供。如果都不提供，则原始请求的路径将用于重定向。该值必须介于 1 和 1024 个字符之间。

返回：成功

redirectResponseCode

字符串

用于此 RedirectAction 的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，它是默认值，对应于 301。

* FOUND，对应于 302。

* SEE_OTHER，对应于 303。

* TEMPORARY_REDIRECT，对应于 307。在这种情况下，将保留请求方法。

* PERMANENT_REDIRECT，对应于 308。在这种情况下，将保留请求方法。

返回：成功

stripQuery

布尔值

如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何随附查询部分。如果设置为 false，则保留原始 URL 的查询部分。默认值为 false。

返回：成功

region

字符串

对 URL 映射所在的区域的引用。

返回：成功

tests

complex

预期 URL 映射的列表。只有当所有测试用例都通过时，更新此 UrlMap 的请求才会成功。

返回：成功

description

字符串

此测试用例的描述。

返回：成功

host

字符串

URL 的主机部分。

返回：成功

path

字符串

URL 的路径部分。

返回：成功

service

字典

对给定 URL 应映射到的预期 RegionBackendService 资源的引用。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)