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 的字典。或者,您可以将 `register: name-of-resource` 添加到 gcp_compute_region_backend_service 任务,然后将此 default_service 字段设置为“{{ name-of-resource }}”

default_url_redirect

字典

如果未匹配任何指定的 hostRules,则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect,则不能设置 defaultService 或 defaultRouteAction。

host_redirect

字符串

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

https_redirect

布尔值

如果设置为 true,则重定向请求中的 URL 方案将设置为 https。如果设置为 false,则重定向请求的 URL 方案将与请求的 URL 方案相同。这只能为 TargetHttpProxys 中使用的 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

description

字符串

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

env_type

字符串

指定您在哪个 Ansible 环境中运行此模块。

除非您知道自己在做什么,否则不应设置此项。

这只会更改任何 API 请求的用户代理字符串。

host_rules

列表 / 元素=字典

用于 URL 的 HostRules 列表。

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 的命名 PathMatchers 列表。

default_service

字典

对 RegionBackendService 资源的引用。如果此 PathMatcher 定义的 pathRules 中没有一个与 URL 的路径部分匹配,则将使用此资源。

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

default_url_redirect

字典

如果未匹配任何指定的 hostRules,则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect,则不能设置 defaultService 或 defaultRouteAction。

host_redirect

字符串

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

https_redirect

布尔值

如果设置为 true,则重定向请求中的 URL 方案将设置为 https。如果设置为 false,则重定向请求的 URL 方案将与请求的 URL 方案相同。这只能为 TargetHttpProxys 中使用的 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

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

字典

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

abort

字典

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

http_status

整数 / 必需

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599(含)之间。

percentage

字符串 / 必需

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

delay

字典

作为故障注入的一部分,在将客户端请求发送到后端服务之前,如何延迟客户端请求的规范。

fixed_delay

字典 / 必需

指定固定延迟间隔的值。

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

percentage

字符串 / 必需

作为故障注入一部分将引入延迟的流量(连接/操作/请求)的百分比。该值必须介于 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(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 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(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

url_rewrite

字典

在将请求转发到匹配的服务之前修改请求 URL 的规范。

host_rewrite

字符串

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

path_prefix_rewrite

字符串

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

weighted_backend_services

列表 / 元素=字典

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流向其对应后端服务的流量比例。如果所有流量都需要发送到单个后端服务,则必须有一个 weight 设置为非 0 数字的 weightedBackendService。一旦识别出 backendService,并且在将请求转发到后端服务之前,将根据在此 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

列表 / 元素=字典

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

header_name

字符串 / 必需

报头的名称。

header_value

字符串 / 必需

要添加的报头的值。

replace

布尔值 / 必需

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

选项

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

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 指定了任何 weightedBackendServices,则不能指定 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 方案相同。这只能针对 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

route_rules

列表 / 元素=字典

有序 HTTP 路由规则列表。如果需要高级路由匹配和路由操作,请使用此列表代替 pathRules。指定 routeRules 的顺序很重要:匹配的第一个规则将导致其指定的路由操作生效。在给定的 pathMatcher 中,只能设置 pathRules 或 routeRules 中的一个。routeRules 不支持用于外部负载均衡器的 UrlMaps。

header_action

字典

指定需要对所选 backendService 生效的请求和响应报头的更改。此处指定的 headerAction 在匹配的 pathMatchers[].headerAction 之前应用,并在 pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 之后应用。

request_headers_to_add

列表 / 元素=字典

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

header_name

字符串 / 必需

报头的名称。

header_value

字符串 / 必需

要添加的报头的值。

replace

布尔值 / 必需

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

选项

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

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 请求的授权,请使用 headerName 为“:authority” 的 headerMatch。要匹配请求的方法,请使用 headerName“: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 仅适用于 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

filter_labels

列表 / 元素=字典 / 必需

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

name

字符串 / 必需

元数据标签的名称。名称的最大长度为 1024 个字符,且必须至少包含 1 个字符。

字符串 / 必需

标签的值必须与指定的值匹配。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 的评估顺序是按优先级从低到高排序的。第一个与请求匹配的规则将被应用。

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

每个规则的优先级必须设置为 0 到 2147483647(含)之间的数字。

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

route_action

字典

响应匹配的 matchRule,负载均衡器会在将请求转发到选定的后端之前执行高级路由操作,例如 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 策略已禁用。

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

选项

  • false ← (默认)

  • true

expose_headers

列表 / 元素=字符串

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

max_age

整数

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

fault_injection_policy

字典

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

abort

字典

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

http_status

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599(含)之间。

percentage

字符串

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

delay

字典

作为故障注入的一部分,在将客户端请求发送到后端服务之前,如何延迟客户端请求的规范。

fixed_delay

字典

指定固定延迟间隔的值。

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

percentage

字符串

作为故障注入一部分将引入延迟的流量(连接/操作/请求)的百分比。该值必须介于 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(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 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(含)之间。

seconds

字符串 / 必需

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

url_rewrite

字典

在将请求转发到匹配的服务之前修改请求 URL 的规范。

host_rewrite

字符串

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

path_prefix_rewrite

字符串

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

weighted_backend_services

列表 / 元素=字典

发生路由匹配时要将流量发送到的加权后端服务列表。权重决定流向其对应后端服务的流量比例。如果所有流量都需要发送到单个后端服务,则必须有一个 weight 设置为非 0 数字的 weightedBackendService。一旦识别出 backendService,并且在将请求转发到后端服务之前,将根据在此 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

列表 / 元素=字典

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

header_name

字符串 / 必需

报头的名称。

header_value

字符串 / 必需

要添加的报头的值。

replace

布尔值 / 必需

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

选项

  • false

  • true

request_headers_to_remove

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

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 指定了任何 weightedBackendServices,则不能指定 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 方案相同。这只能针对 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。

选项

  • false ← (默认)

  • true

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

url map 所在区域的引用。

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

字典 / 必需

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

此字段表示 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 文本格式表示的创建时间戳。

已返回:success

defaultService

字典

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

已返回:success

defaultUrlRedirect

complex

如果未匹配任何指定的 hostRules,则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect,则不能设置 defaultService 或 defaultRouteAction。

已返回:success

hostRedirect

字符串

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

已返回:success

httpsRedirect

布尔值

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

已返回:success

pathRedirect

字符串

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

已返回:success

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀,保留重定向请求之前的 URL 的其余部分。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个或两者都不提供。如果两者都没有提供,则将使用原始请求的路径进行重定向。值必须在 1 到 1024 个字符之间。

已返回:success

redirectResponseCode

字符串

为此 RedirectAction 使用的 HTTP 状态代码。支持的值为:* MOVED_PERMANENTLY_DEFAULT,这是默认值,对应于 301。

* FOUND,对应于 302。

* SEE_OTHER,对应于 303。

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

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

已返回:success

stripQuery

布尔值

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

已返回:success

description

字符串

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

已返回:success

fingerprint

字符串

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

已返回:success

hostRules

complex

用于 URL 的 HostRules 列表。

已返回:success

description

字符串

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

已返回:success

hosts

列表 / 元素=字符串

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

已返回:success

pathMatcher

字符串

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

已返回:success

id

整数

资源的唯一标识符。

已返回:success

name

字符串

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

已返回:success

pathMatchers

complex

用于 URL 的命名 PathMatchers 列表。

已返回:success

defaultService

字典

对 RegionBackendService 资源的引用。如果此 PathMatcher 定义的 pathRules 中没有一个与 URL 的路径部分匹配,则将使用此资源。

已返回:success

defaultUrlRedirect

complex

如果未匹配任何指定的 hostRules,则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect,则不能设置 defaultService 或 defaultRouteAction。

已返回:success

hostRedirect

字符串

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

已返回:success

httpsRedirect

布尔值

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

已返回:success

pathRedirect

字符串

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

已返回:success

prefixRedirect

字符串

替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀,保留重定向请求之前的 URL 的其余部分。

prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个或两者都不提供。如果两者都没有提供,则将使用原始请求的路径进行重定向。值必须在 1 到 1024 个字符之间。

已返回:success

redirectResponseCode

字符串

为此 RedirectAction 使用的 HTTP 状态代码。支持的值为:* MOVED_PERMANENTLY_DEFAULT,这是默认值,对应于 301。

* FOUND,对应于 302。

* SEE_OTHER,对应于 303。

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

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

已返回:success

stripQuery

布尔值

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

已返回:success

description

字符串

此资源的可选描述。

已返回:success

name

字符串

HostRule 引用的此 PathMatcher 的名称。

已返回:success

pathRules

complex

路径规则列表。如果只需要基于简单的路径匹配进行路由,请使用此列表代替 routeRules。路径规则的指定顺序无关紧要。匹配始终基于最长路径优先原则进行。例如:路径为 /a/b/c/* 的 pathRule 将优先于 /a/b/* 匹配,无论这些路径在此列表中的出现顺序如何。在给定的 pathMatcher 中,只能设置 pathRules 或 routeRules 中的一个。

已返回:success

paths

列表 / 元素=字符串

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

已返回:success

routeAction

complex

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

已返回:success

corsPolicy

complex

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

已返回:success

allowCredentials

布尔值

响应预检请求时,将其设置为 true 表示实际请求可以包含用户凭据。这将转换为 Access-Control-Allow-Credentials 报头。默认为 false。

已返回:success

allowHeaders

列表 / 元素=字符串

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

已返回:success

allowMethods

列表 / 元素=字符串

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

已返回:success

allowOriginRegexes

列表 / 元素=字符串

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

已返回:success

allowOrigins

列表 / 元素=字符串

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

已返回:success

disabled

布尔值

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

已返回:success

exposeHeaders

列表 / 元素=字符串

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

已返回:success

maxAge

整数

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

已返回:success

faultInjectionPolicy

complex

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

已返回:success

abort

complex

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

已返回:success

httpStatus

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599(含)之间。

已返回:success

percentage

字符串

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

已返回:success

delay

complex

作为故障注入的一部分,在将客户端请求发送到后端服务之前,如何延迟客户端请求的规范。

已返回:success

fixedDelay

complex

指定固定延迟间隔的值。

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

percentage

字符串

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

已返回:success

请求镜像策略

complex

指定如何将打算用于路由后端的请求镜像到单独的镜像后端服务的策略。负载均衡器不会等待镜像服务的响应。在将流量发送到镜像服务之前,主机/授权报头将后缀为 -shadow。

已返回:success

后端服务

字典

要镜像到的 RegionBackendService 资源。

已返回:success

重试策略

complex

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

已返回:success

重试次数

整数

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

已返回:success

每次重试超时时间

complex

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

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

重试条件

列表 / 元素=字符串

指定此重试规则适用的一个或多个条件。有效值为:- 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,负载均衡器将重试。

已返回:success

timeout

complex

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

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

URL重写

complex

在将请求转发到匹配的服务之前修改请求 URL 的规范。

已返回:success

主机重写

字符串

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

已返回:success

路径前缀重写

字符串

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

已返回:success

加权后端服务

complex

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

已返回:success

后端服务

字典

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前,负载均衡器将应用此 backendServiceWeight 中指定的任何相关 headerActions。

已返回:success

头部操作

complex

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

已返回:success

要添加的请求头

complex

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的请求头

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

已返回:success

要添加的响应头

complex

在将响应发送回客户端之前,要添加到响应的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的响应头

列表 / 元素=字符串

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

已返回:success

weight

整数

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

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

已返回:success

service

字典

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

已返回:success

URL重定向

complex

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

已返回:success

hostRedirect

字符串

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

已返回:success

httpsRedirect

布尔值

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

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

已返回:success

pathRedirect

字符串

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

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

已返回:success

prefixRedirect

字符串

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

已返回:success

redirectResponseCode

字符串

为此 RedirectAction 使用的 HTTP 状态代码。支持的值为:* MOVED_PERMANENTLY_DEFAULT,这是默认值,对应于 301。

* FOUND,对应于 302。

* SEE_OTHER,对应于 303。

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

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

已返回:success

stripQuery

布尔值

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

已返回:success

路由规则

complex

有序 HTTP 路由规则列表。如果需要高级路由匹配和路由操作,请使用此列表代替 pathRules。指定 routeRules 的顺序很重要:匹配的第一个规则将导致其指定的路由操作生效。在给定的 pathMatcher 中,只能设置 pathRules 或 routeRules 中的一个。routeRules 不支持用于外部负载均衡器的 UrlMaps。

已返回:success

头部操作

complex

指定需要对所选 backendService 生效的请求和响应报头的更改。此处指定的 headerAction 在匹配的 pathMatchers[].headerAction 之前应用,并在 pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 之后应用。

已返回:success

要添加的请求头

complex

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的请求头

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

已返回:success

要添加的响应头

complex

在将响应发送回客户端之前,要添加到响应的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的响应头

列表 / 元素=字符串

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

已返回:success

匹配规则

complex

匹配规则的确定方法。

已返回:success

完整路径匹配

字符串

为了满足 matchRule 条件,请求的路径必须与 fullPathMatch 中指定的值完全匹配,前提是需要移除原始 URL 中可能存在的任何查询参数和锚点。FullPathMatch 的字符数必须在 1 到 1024 之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。

已返回:success

头部匹配

complex

指定一组报头匹配条件,所有条件都必须与请求中的相应报头匹配。

已返回:success

精确匹配

字符串

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

已返回:success

头部名称

字符串

要匹配的 HTTP 报头的名称。要匹配 HTTP 请求的授权,请使用 headerName 为“:authority” 的 headerMatch。要匹配请求的方法,请使用 headerName“:method”。

已返回:success

反向匹配

布尔值

如果设置为 false,则如果满足上述匹配条件,则 headerMatch 被视为匹配。如果设置为 true,则如果上述匹配条件 *不* 满足,则 headerMatch 被视为匹配。默认为 false。

已返回:success

前缀匹配

字符串

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

已返回:success

存在匹配

布尔值

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

已返回:success

范围匹配

complex

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

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

已返回:success

范围结束

整数

范围的结束值(不包含)。

已返回:success

范围开始

整数

范围的起始值(包含)。

已返回:success

正则表达式匹配

字符串

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

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

已返回:success

后缀匹配

字符串

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

已返回:success

忽略大小写

布尔值

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

默认为 false。

已返回:success

元数据过滤器

complex

负载均衡器使用的模糊过滤器条件,用于将路由配置限制为一组受限的符合 xDS 的客户端。在它们对负载均衡器的 xDS 请求中,xDS 客户端会呈现节点元数据。如果发生匹配,则相关的路由配置将提供给这些代理。对于此列表中的每个 metadataFilter,如果其 filterMatchCriteria 设置为 MATCH_ANY,则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL,则其所有 filterLabels 都必须与提供的元数据中的相应标签匹配。此处指定的 metadataFilters 可以覆盖引用此 UrlMap 的 ForwardingRule 中指定的那些。metadataFilters 仅适用于 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。

已返回:success

过滤器标签

complex

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

已返回:success

name

字符串

元数据标签的名称。名称的最大长度为 1024 个字符,且必须至少包含 1 个字符。

已返回:success

字符串

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

已返回:success

过滤器匹配条件

字符串

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

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

已返回:success

前缀匹配

字符串

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

已返回:success

查询参数匹配

complex

指定一组查询参数匹配条件,所有条件都必须与请求中的相应查询参数匹配。

已返回:success

精确匹配

字符串

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

已返回:success

name

字符串

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

已返回:success

存在匹配

布尔值

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

已返回:success

正则表达式匹配

字符串

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

已返回:success

正则表达式匹配

字符串

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

已返回:success

priority

整数

对于给定 pathMatcher 中的 routeRules,优先级决定负载均衡器解释 routeRules 的顺序。routeRules 的评估顺序是按优先级从低到高排序的。第一个与请求匹配的规则将被应用。

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

每个规则的优先级必须设置为 0 到 2147483647(含)之间的数字。

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

已返回:success

routeAction

complex

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

已返回:success

corsPolicy

complex

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

已返回:success

allowCredentials

布尔值

响应预检请求时,将其设置为 true 表示实际请求可以包含用户凭据。这将转换为 Access-Control-Allow-Credentials 报头。默认为 false。

已返回:success

allowHeaders

列表 / 元素=字符串

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

已返回:success

allowMethods

列表 / 元素=字符串

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

已返回:success

allowOriginRegexes

列表 / 元素=字符串

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

已返回:success

allowOrigins

列表 / 元素=字符串

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

已返回:success

disabled

布尔值

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

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

已返回:success

exposeHeaders

列表 / 元素=字符串

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

已返回:success

maxAge

整数

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

已返回:success

faultInjectionPolicy

complex

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

已返回:success

abort

complex

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

已返回:success

httpStatus

整数

用于中止请求的 HTTP 状态代码。该值必须介于 200 和 599(含)之间。

已返回:success

percentage

字符串

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

已返回:success

delay

complex

作为故障注入的一部分,在将客户端请求发送到后端服务之前,如何延迟客户端请求的规范。

已返回:success

fixedDelay

complex

指定固定延迟间隔的值。

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

percentage

字符串

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

已返回:success

请求镜像策略

complex

指定如何将打算用于路由后端的请求镜像到单独的镜像后端服务的策略。负载均衡器不会等待镜像服务的响应。在将流量发送到镜像服务之前,主机/授权报头将后缀为 -shadow。

已返回:success

后端服务

字典

要镜像到的 RegionBackendService 资源。

已返回:success

重试策略

complex

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

已返回:success

重试次数

整数

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

已返回:success

每次重试超时时间

complex

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

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

重试条件

列表 / 元素=字符串

指定此重试规则适用的一个或多个条件。有效值为:* 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,负载均衡器将重试。

已返回:success

timeout

complex

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

已返回:success

nanos

整数

以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999(含)之间。

已返回:success

seconds

字符串

以秒为分辨率表示的时间跨度。必须介于 0 到 315,576,000,000(含)之间。

已返回:success

URL重写

complex

在将请求转发到匹配的服务之前修改请求 URL 的规范。

已返回:success

主机重写

字符串

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

已返回:success

路径前缀重写

字符串

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

已返回:success

加权后端服务

complex

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

已返回:success

后端服务

字典

默认的 RegionBackendService 资源。在将请求转发到 backendService 之前,负载均衡器将应用此 backendServiceWeight 中指定的任何相关 headerActions。

已返回:success

头部操作

complex

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

已返回:success

要添加的请求头

complex

在将请求转发到 backendService 之前,要添加到匹配请求的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的请求头

列表 / 元素=字符串

需要从请求中删除的报头名称列表,在将请求转发到 backendService 之前。

已返回:success

要添加的响应头

complex

在将响应发送回客户端之前,要添加到响应的报头。

已返回:success

头部名称

字符串

报头的名称。

已返回:success

头部值

字符串

要添加的报头的值。

已返回:success

replace

布尔值

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

已返回:success

要移除的响应头

列表 / 元素=字符串

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

已返回:success

weight

整数

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

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

已返回:success

service

字典

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

已返回:success

URL重定向

complex

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

已返回:success

hostRedirect

字符串

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

已返回:success

httpsRedirect

布尔值

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

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

已返回:success

pathRedirect

字符串

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

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

已返回:success

prefixRedirect

字符串

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

已返回:success

redirectResponseCode

字符串

为此 RedirectAction 使用的 HTTP 状态代码。支持的值为:* MOVED_PERMANENTLY_DEFAULT,这是默认值,对应于 301。

* FOUND,对应于 302。

* SEE_OTHER,对应于 303。

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

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

已返回:success

stripQuery

布尔值

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

已返回:success

region

字符串

url map 所在区域的引用。

已返回:success

tests

complex

预期的 URL 映射列表。只有在所有测试用例都通过的情况下,更新此 UrlMap 的请求才会成功。

已返回:success

description

字符串

此测试用例的描述。

已返回:success

host

字符串

URL 的主机部分。

已返回:success

path

字符串

URL 的路径部分。

已返回:success

service

字典

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

已返回:success

作者

  • Google Inc. (@googlecloudplatform)