google.cloud.gcp_compute_region_url_map_info 模块 – 收集 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_info。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的完整性测试失败。请参阅 讨论主题 以了解更多信息。
概要
收集 GCP RegionUrlMap 信息
要求
执行此模块的主机需要以下要求。
python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0
参数
参数 |
注释 |
|---|---|
如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。 |
|
使用的凭据类型。 选项
|
|
指定您在此模块中运行的 Ansible 环境。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。 |
|
过滤器值对列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。 列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。 |
|
要使用的 Google Cloud Platform 项目。 |
|
URL 地图所在的区域的引用。 |
|
要使用的作用域数组 |
|
服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。 |
|
如果选择 machineaccount 并且用户不希望使用默认电子邮件，则可以选择的服务帐户电子邮件地址。 |
|
如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。 |
备注
注意
对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_FILE环境变量设置 service_account_file。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_CONTENTS环境变量设置 service_account_contents。对于身份验证，您可以使用
GCP_SERVICE_ACCOUNT_EMAIL环境变量设置 service_account_email。对于身份验证，您可以使用
GCP_ACCESS_TOKEN环境变量设置 access_token。对于身份验证，您可以使用
GCP_AUTH_KIND环境变量设置 auth_kind。对于身份验证，您可以使用
GCP_SCOPES环境变量设置 scopes。只有在未设置 playbook 值时，才会使用环境变量值。
*service_account_email* 和 *service_account_file* 选项是互斥的。
示例
- name: get info on a region URL map
gcp_compute_region_url_map_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
返回值
此处记录了常见的返回值 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源列表 返回：始终 |
|
以 RFC3339 文本格式表示的创建时间戳。 返回：成功 |
|
如果没有任何 hostRules 匹配，则将流量定向到的 defaultService 资源的完整或部分 URL。如果额外指定了 defaultRouteAction，则在将请求发送到后端之前，将生效高级路由操作，例如 URL 重写等。但是，如果指定了 defaultService，则 defaultRouteAction 不能包含任何 weightedBackendServices。相反，如果 routeAction 指定任何 weightedBackendServices，则 service 必须不指定。只能设置 defaultService、defaultUrlRedirect 或 defaultRouteAction.weightedBackendService 中的一个。 返回：成功 |
|
如果没有任何指定的 hostRules 匹配，则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不能设置 defaultService 或 defaultRouteAction。 返回：成功 |
|
将在重定向响应中使用的主机，而不是请求中提供的那个主机。值必须介于 1 到 255 个字符之间。 返回：成功 |
|
如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将保持与请求的 URL 方案相同。这必须仅设置为在 TargetHttpProxys 中使用的 UrlMaps。不允许将此设置为 TargetHttpsProxy 的 true。默认为 false。 返回：成功 |
|
将在重定向响应中使用的路径，而不是请求中提供的那个路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。值必须介于 1 到 1024 个字符之间。 返回：成功 |
|
替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后重定向请求。 prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。值必须介于 1 到 1024 个字符之间。 返回：成功 |
|
此重定向操作使用的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，这是默认值，对应于 301。 * FOUND，对应于 302。 * SEE_OTHER，对应于 303。 * TEMPORARY_REDIRECT，对应于 307。在这种情况下，请求方法将被保留。 * PERMANENT_REDIRECT，对应于 308。在这种情况下，请求方法将被保留。 返回：成功 |
|
如果设置为 true，则在重定向请求之前，将删除原始 URL 中任何伴随的查询部分。如果设置为 false，则保留原始 URL 的查询部分。 返回：成功 |
|
此资源的可选描述。创建资源时提供此属性。 返回：成功 |
|
此资源的指纹。此字段在更新此资源期间内部使用。 返回：成功 |
|
要针对 URL 使用的 HostRules 列表。 返回：成功 |
|
此 HostRule 的可选描述。创建资源时提供此属性。 返回：成功 |
|
要匹配的主机模式列表。它们必须是有效的主机名，但 * 将匹配任何 ([a-z0-9-.]*) 字符串。在这种情况下，* 必须是第一个字符，并且在模式中之后必须跟有 - 或 .。 返回：成功 |
|
如果 hostRule 匹配 URL 的主机部分，则使用其匹配 URL 路径部分的 PathMatcher 的名称。 返回：成功 |
|
资源的唯一标识符。 返回：成功 |
|
资源的名称。资源创建时由客户端提供。名称必须为 1-63 个字符长，并符合 RFC1035。具体来说，名称必须为 1-63 个字符长，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，最后一个字符除外，最后一个字符不能是连字符。 返回：成功 |
|
要针对 URL 使用的命名 PathMatchers 列表。 返回：成功 |
|
对 RegionBackendService 资源的引用。如果此 PathMatcher 定义的任何 pathRules 都没有与 URL 的路径部分匹配，则将使用此资源。 返回：成功 |
|
如果没有任何指定的 hostRules 匹配，则请求将重定向到 defaultUrlRedirect 指定的 URL。如果指定了 defaultUrlRedirect，则不能设置 defaultService 或 defaultRouteAction。 返回：成功 |
|
将在重定向响应中使用的主机，而不是请求中提供的那个主机。值必须介于 1 到 255 个字符之间。 返回：成功 |
|
如果设置为 true，则重定向请求中的 URL 方案将设置为 https。如果设置为 false，则重定向请求的 URL 方案将保持与请求的 URL 方案相同。这必须仅设置为在 TargetHttpProxys 中使用的 UrlMaps。不允许将此设置为 TargetHttpsProxy 的 true。默认为 false。 返回：成功 |
|
将在重定向响应中使用的路径，而不是请求中提供的那个路径。pathRedirect 不能与 prefixRedirect 一起提供。单独提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。值必须介于 1 到 1024 个字符之间。 返回：成功 |
|
替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后重定向请求。 prefixRedirect 不能与 pathRedirect 一起提供。单独提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。值必须介于 1 到 1024 个字符之间。 返回：成功 |
|
此重定向操作使用的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，这是默认值，对应于 301。 * FOUND，对应于 302。 * SEE_OTHER，对应于 303。 * TEMPORARY_REDIRECT，对应于 307。在这种情况下，请求方法将被保留。 * PERMANENT_REDIRECT，对应于 308。在这种情况下，请求方法将被保留。 返回：成功 |
|
如果设置为 true，则在重定向请求之前，将删除原始 URL 中任何伴随的查询部分。如果设置为 false，则保留原始 URL 的查询部分。 返回：成功 |
|
此资源的可选描述。 返回：成功 |
|
HostRule 引用此 PathMatcher 的名称。 返回：成功 |
|
路径规则列表。如果只需要基于简单的路径匹配进行路由，请使用此列表而不是 routeRules。指定路径规则的顺序无关紧要。匹配始终基于最长路径优先。例如：路径为 /a/b/c/* 的 pathRule 将在 /a/b/* 之前匹配，而不管这些路径在此列表中出现的顺序如何。在给定的 pathMatcher 中，只能设置 pathRules 或 routeRules 中的一个。 返回：成功 |
|
要匹配的路径模式列表。每个路径都必须以 / 开头，并且只允许在 / 后面结尾处使用 \*。馈送到路径匹配器的字符串不包括第一个 ? 或 # 之后的任何文本，并且此处不允许使用这些字符。 返回：成功 |
|
响应匹配路径，负载均衡器会在将请求转发到选定的后端之前执行高级路由操作，例如 URL 重写、标头转换等。如果 routeAction 指定任何 weightedBackendServices，则 service 必须未设置。相反，如果设置了 service，则 routeAction 不能包含任何 weightedBackendServices。只能设置 routeAction 或 urlRedirect 中的一个。 返回：成功 |
|
允许客户端跨源请求的规范。请参阅 W3C 跨源资源共享建议。 返回：成功 |
|
响应预检请求时，将其设置为 true 表示实际请求可以包含用户凭据。这将转换为 Access-Control-Allow-Credentials 标头。默认为 false。 返回：成功 |
|
指定 Access-Control-Allow-Headers 标头的內容。 返回：成功 |
|
指定 Access-Control-Allow-Methods 标头的內容。 返回：成功 |
|
指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参见 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。 返回：成功 |
|
指定将允许进行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。 返回：成功 |
|
如果为 true，则指定 CORS 策略已禁用。 返回：成功 |
|
指定 Access-Control-Expose-Headers 标头的內容。 返回：成功 |
|
指定预检请求的结果可以缓存多长时间。这将转换为 Access-Control-Max-Age 标头的內容。 返回：成功 |
|
将故障注入流量中以测试客户端对后端服务故障的弹性的规范。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定比例的请求上引入延迟。同样，负载均衡器可以为一定比例的请求中止来自客户端的请求。配置了 fault_injection_policy 的客户端将忽略 timeout 和 retry_policy。 返回：成功 |
|
指定如何在故障注入过程中中止客户端请求。 返回：成功 |
|
用于中止请求的 HTTP 状态代码。值必须介于 200 和 599（含）之间。 返回：成功 |
|
作为故障注入的一部分将被中止的流量（连接/操作/请求）的百分比。值必须介于 0.0 和 100.0（含）之间。 返回：成功 |
|
指定如何在故障注入过程中延迟客户端请求（在发送到后端服务之前）。 返回：成功 |
|
指定固定延迟间隔的值。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
作为故障注入的一部分将引入延迟的流量（连接/操作/请求）的百分比。值必须介于 0.0 和 100.0（含）之间。 返回：成功 |
|
指定如何将打算用于路由后端的请求映射到单独的镜像后端服务的策略。负载均衡器不会等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头将附加 -shadow。 返回：成功 |
|
正在镜像到的 RegionBackendService 资源。 返回：成功 |
|
指定与此路由关联的重试策略。 返回：成功 |
|
指定允许的重试次数。此数字必须 > 0。 返回：成功 |
|
指定每次重试尝试的非零超时。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
指定此重试规则适用的一个或多个条件。有效值为：- 5xx：如果后端服务返回任何 5xx 响应代码，或者后端服务根本没有响应（例如：断开连接、重置、读取超时、连接失败和拒绝的流），则负载均衡器将尝试重试。
目前唯一支持的可重试错误是 409。
返回：成功 |
|
指定所选路由的超时。超时是从请求已完全处理（即流结束）到响应已完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
在将请求转发到匹配的服务之前修改请求 URL 的规范。 返回：成功 |
|
在将请求转发到选定的服务之前，请求的主机标头将替换为 hostRewrite 的内容。值必须介于 1 和 255 个字符之间。 返回：成功 |
|
在将请求转发到选定的后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
发生路由匹配时要向其发送流量的加权后端服务列表。权重决定流向其对应后端服务的流量比例。如果所有流量都需要转到单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。一旦确定了后端服务，并且在将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作，例如 URL 重写和标头转换。 返回：成功 |
|
默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器将应用作为此 backendServiceWeight 部分指定的任何相关 headerActions。 返回：成功 |
|
指定需要对选定的 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。 返回：成功 |
|
在将请求转发到 backendService 之前添加到匹配请求的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从请求中删除的标头的标头名称列表，然后再将请求转发到 backendService。 返回：成功 |
|
在将响应发送回客户端之前添加到响应的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从响应中删除的标头的标头名称列表，然后再将响应发送回客户端。 返回：成功 |
|
指定发送到后端服务的流量比例，计算公式为 weight /（routeAction 中所有 weightedBackendService 权重的总和）。后端服务的选取仅针对新流量进行确定。一旦用户的请求被定向到某个后端服务，后续请求将根据后端服务的会话关联策略发送到同一个后端服务。 该值必须介于 0 和 1000 之间。 返回：成功 |
|
如果匹配此规则，则将流量定向到的区域后端服务资源。如果额外指定了 routeAction，则在将请求发送到后端之前，将生效高级路由操作，例如 URL 重写等。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。反之，如果 routeAction 指定了任何 weightedBackendServices，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。 返回：成功 |
|
当匹配路径模式时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不能设置 service 或 routeAction。 返回：成功 |
|
将在重定向响应中使用的主机，而不是请求中提供的那个主机。值必须介于 1 到 255 个字符之间。 返回：成功 |
|
如果设置为 true，则重定向请求中的 URL 方案将设置为 https。 如果设置为 false，则重定向请求的 URL 方案将保持与请求的 URL 方案相同。这只能设置为在 TargetHttpProxy 中使用的 UrlMap。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。 返回：成功 |
|
将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。只提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。 该值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。只提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。该值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
此重定向操作使用的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，这是默认值，对应于 301。 * FOUND，对应于 302。 * SEE_OTHER，对应于 303。 * TEMPORARY_REDIRECT，对应于 307。在这种情况下，请求方法将被保留。 * PERMANENT_REDIRECT，对应于 308。在这种情况下，请求方法将被保留。 返回：成功 |
|
如果设置为 true，则在重定向请求之前，将删除原始 URL 中任何伴随的查询部分。如果设置为 false，则保留原始 URL 的查询部分。 返回：成功 |
|
有序 HTTP 路由规则的列表。当需要高级路由匹配和路由操作时，请使用此列表代替 pathRules。routeRules 的指定顺序很重要：匹配的第一个规则将导致其指定的路由操作生效。在给定的 pathMatcher 中，只能设置 pathRules 或 routeRules 中的一个。routeRules 不支持用于外部负载均衡器的 UrlMap。 返回：成功 |
|
指定需要对选定的 backendService 生效的请求和响应标头更改。此处指定的 headerAction 应用于匹配的 pathMatchers[].headerAction 之前，并应用于 pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction 之后。 返回：成功 |
|
在将请求转发到 backendService 之前添加到匹配请求的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从请求中删除的标头的标头名称列表，然后再将请求转发到 backendService。 返回：成功 |
|
在将响应发送回客户端之前添加到响应的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从响应中删除的标头的标头名称列表，然后再将响应发送回客户端。 返回：成功 |
|
确定匹配的规则。 返回：成功 |
|
为了满足 matchRule 条件，请求的路径必须与 fullPathMatch 中指定的值完全匹配，前提是已删除原始 URL 中可能包含的任何查询参数和锚点。FullPathMatch 必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。 返回：成功 |
|
指定必须与请求中的相应标头匹配的标头匹配条件列表。 返回：成功 |
|
该值应与 exactMatch 的内容完全匹配。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
要匹配的 HTTP 标头的名称。要针对 HTTP 请求的权限进行匹配，请使用 headerName 为“:authority”的 headerMatch。要匹配请求的方法，请使用 headerName“:method”。 返回：成功 |
|
如果设置为 false，则如果满足上述匹配条件，则 headerMatch 将被视为匹配。如果设置为 true，则如果上述匹配条件不满足，则 headerMatch 将被视为匹配。默认为 false。 返回：成功 |
|
标头的值必须以 prefixMatch 的内容开头。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
必须存在具有 headerName 内容的标头。无论请求的标头是否有值，匹配都会发生。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
标头值必须是整数，并且其值必须在 rangeMatch 指定的范围内。如果标头不包含整数、数字或为空，则匹配失败。例如，对于范围 [-5, 0]，*-3 将匹配，*0 将不匹配，*0.25 将不匹配，*-3someString 将不匹配。 只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
范围的结束（不包含）。 返回：成功 |
|
范围的开始（包含）。 返回：成功 |
|
标头的值必须与 regexMatch 中指定的正则表达式匹配。有关正则表达式语法，请参阅：en.cppreference.com/w/cpp/regex/ecmascript 要针对 HTTP 请求中指定的端口进行匹配，请使用 headerName 设置为 PORT 且正则表达式满足 RFC2616 Host 标头的端口说明符的 headerMatch。 只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
标头的值必须以 suffixMatch 的内容结尾。只能设置 exactMatch、prefixMatch、suffixMatch、regexMatch、presentMatch 或 rangeMatch 中的一个。 返回：成功 |
|
指定 prefixMatch 和 fullPathMatch 匹配是否区分大小写。 默认为 false。 返回：成功 |
|
负载均衡器使用的不明确筛选条件，用于将路由配置限制为有限的一组兼容 xDS 的客户端。在它们对负载均衡器的 xDS 请求中，xDS 客户端会提供节点元数据。如果发生匹配，则相关的路由配置将提供给这些代理。对于此列表中的每个 metadataFilter，如果其 filterMatchCriteria 设置为 MATCH_ANY，则至少一个 filterLabels 必须与元数据中提供的相应标签匹配。如果其 filterMatchCriteria 设置为 MATCH_ALL，则其所有 filterLabels 都必须与提供的元数据中的相应标签匹配。此处指定的 metadataFilters 可以覆盖引用此 UrlMap 的 ForwardingRule 中指定的那些 metadataFilters。metadataFilters 仅适用于其 loadBalancingScheme 设置为 INTERNAL_SELF_MANAGED 的负载均衡器。 返回：成功 |
|
必须根据 filterMatchCriteria 与提供的元数据中的标签匹配的标签值对列表。此列表不能为空，最多可以包含 64 个条目。 返回：成功 |
|
元数据标签的名称。名称的最大长度为 1024 个字符，并且必须至少包含 1 个字符。 返回：成功 |
|
标签的值必须与指定的值匹配。value 的最大长度为 1024 个字符。 返回：成功 |
|
指定 filterLabels 列表中各个 filterLabel 匹配如何对整体 metadataFilter 匹配做出贡献。支持的值为：* MATCH_ANY：至少一个 filterLabels 必须在提供的元数据中具有匹配的标签。 * MATCH_ALL：所有 filterLabels 都必须在提供的元数据中具有匹配的标签。 返回：成功 |
|
为了满足 matchRule 条件，请求的路径必须以指定的 prefixMatch 开头。prefixMatch 必须以 / 开头。该值必须介于 1 和 1024 个字符之间。只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。 返回：成功 |
|
指定必须与请求中相应的查询参数匹配的查询参数匹配条件列表。 返回：成功 |
|
如果参数的值与 exactMatch 的内容完全匹配，则 queryParameterMatch 匹配。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。 返回：成功 |
|
要匹配的查询参数的名称。查询参数必须存在于请求中，否则请求匹配将失败。 返回：成功 |
|
指定如果请求包含查询参数，则 queryParameterMatch 匹配，无论参数是否有值。只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。 返回：成功 |
|
如果参数的值与 regexMatch 指定的正则表达式匹配，则 queryParameterMatch 匹配。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 只能设置 presentMatch、exactMatch 和 regexMatch 中的一个。 返回：成功 |
|
为了满足 matchRule 条件，请求的路径必须满足 regexMatch 中指定的正则表达式，前提是已删除原始 URL 中提供的任何查询参数和锚点。有关正则表达式语法，请参阅 en.cppreference.com/w/cpp/regex/ecmascript 只能指定 prefixMatch、fullPathMatch 或 regexMatch 中的一个。 返回：成功 |
|
对于给定 pathMatcher 中的 routeRules，优先级决定负载均衡器解释 routeRules 的顺序。将按优先级顺序评估 RouteRules，从最低到最高的数字。规则的优先级随着其数字的增加而降低（1、2、3、N+1）。应用与请求匹配的第一个规则。 您不能配置两个或多个具有相同优先级的 routeRules。 每个规则的优先级必须设置为介于 0 和 2147483647（含）之间的数字。 优先级数字可以有间隙，这使您能够在将来添加或删除规则，而不会影响其余规则。例如，1、2、3、4、5、9、12、16 是一系列有效的优先级数字，您可以在将来向其中添加编号为 6 到 8、10 到 11 和 13 到 15 的规则，而不会对现有规则产生任何影响。 返回：成功 |
|
响应匹配的 matchRule，负载均衡器将在将请求转发到选定的后端之前执行高级路由操作，例如 URL 重写、标头转换等。如果 routeAction 指定了任何 weightedBackendServices，则不能设置 service。反之，如果设置了 service，则 routeAction 不能包含任何 weightedBackendServices。只能设置 routeAction 或 urlRedirect 中的一个。 返回：成功 |
|
允许客户端跨源请求的规范。请参阅 W3C 跨源资源共享建议。 返回：成功 |
|
响应预检请求时，将其设置为 true 表示实际请求可以包含用户凭据。这将转换为 Access-Control-Allow-Credentials 标头。默认为 false。 返回：成功 |
|
指定 Access-Control-Allow-Headers 标头的內容。 返回：成功 |
|
指定 Access-Control-Allow-Methods 标头的內容。 返回：成功 |
|
指定与允许的来源匹配的正则表达式模式。有关正则表达式语法，请参见 en.cppreference.com/w/cpp/regex/ecmascript 如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。 返回：成功 |
|
指定将允许进行 CORS 请求的来源列表。如果来源与 allow_origins 或 allow_origin_regex 匹配，则允许该来源。 返回：成功 |
|
如果为 true，则指定 CORS 策略已禁用。 这表示 CORS 策略正在生效。默认为 false。 返回：成功 |
|
指定 Access-Control-Expose-Headers 标头的內容。 返回：成功 |
|
指定预检请求的结果可以缓存多长时间。这将转换为 Access-Control-Max-Age 标头的內容。 返回：成功 |
|
将故障注入流量中以测试客户端对后端服务故障的弹性的规范。作为故障注入的一部分，当客户端向后端服务发送请求时，负载均衡器可以在将这些请求发送到后端服务之前，在一定比例的请求上引入延迟。同样，负载均衡器可以为一定比例的请求中止来自客户端的请求。配置了 fault_injection_policy 的客户端将忽略 timeout 和 retry_policy。 返回：成功 |
|
指定如何在故障注入过程中中止客户端请求。 返回：成功 |
|
用于中止请求的 HTTP 状态代码。值必须介于 200 和 599（含）之间。 返回：成功 |
|
作为故障注入的一部分将被中止的流量（连接/操作/请求）的百分比。值必须介于 0.0 和 100.0（含）之间。 返回：成功 |
|
指定如何在故障注入过程中延迟客户端请求（在发送到后端服务之前）。 返回：成功 |
|
指定固定延迟间隔的值。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
作为故障注入的一部分将引入延迟的流量（连接/操作/请求）的百分比。值必须介于 0.0 和 100.0（含）之间。 返回：成功 |
|
指定如何将打算用于路由后端的请求映射到单独的镜像后端服务的策略。负载均衡器不会等待来自影子服务的响应。在将流量发送到影子服务之前，主机/授权标头将附加 -shadow。 返回：成功 |
|
正在镜像到的 RegionBackendService 资源。 返回：成功 |
|
指定与此路由关联的重试策略。 返回：成功 |
|
指定允许的重试次数。此数字必须 > 0。 返回：成功 |
|
指定每次重试尝试的非零超时。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
指定此重试规则适用的一个或多个条件。有效值为：* 5xx：如果后端服务返回任何 5xx 响应代码，或者如果后端服务根本没有响应（例如：断开连接、重置、读取超时、连接失败和拒绝的流），则负载均衡器将尝试重试。 * 网关错误：类似于 5xx，但仅适用于响应代码 502、503 或 504。 * 连接失败：由于连接超时等原因，负载均衡器将在连接到后端服务失败时重试。 * 可重试 4xx：负载均衡器将对可重试的 4xx 响应代码进行重试。 目前唯一支持的可重试错误是 409。 * 拒绝的流：如果后端服务使用 REFUSED_STREAM 错误代码重置流，负载均衡器将重试。此重置类型表示可以安全地重试。 * 已取消：如果响应标头中的 gRPC 状态代码设置为已取消，则负载均衡器将重试 * 超时：如果响应标头中的 gRPC 状态代码设置为超时，则负载均衡器将重试 * 资源耗尽：如果响应标头中的 gRPC 状态代码设置为资源耗尽，则负载均衡器将重试 * 不可用：如果响应标头中的 gRPC 状态代码设置为不可用，则负载均衡器将重试。 返回：成功 |
|
指定所选路由的超时。超时是从请求已完全处理（即流结束）到响应已完全处理的时间计算的。超时包括所有重试。如果未指定，则默认值为 15 秒。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
在将请求转发到匹配的服务之前修改请求 URL 的规范。 返回：成功 |
|
在将请求转发到选定的服务之前，请求的主机标头将替换为 hostRewrite 的内容。值必须介于 1 和 255 个字符之间。 返回：成功 |
|
在将请求转发到选定的后端服务之前，请求路径的匹配部分将替换为 pathPrefixRewrite。值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
发生路由匹配时要向其发送流量的加权后端服务列表。权重决定流向其对应后端服务的流量比例。如果所有流量都需要转到单个后端服务，则必须有一个权重设置为非 0 数字的 weightedBackendService。一旦确定了后端服务，并且在将请求转发到后端服务之前，将根据此 HttpRouteAction 中指定的其他设置应用高级路由操作，例如 URL 重写和标头转换。 返回：成功 |
|
默认的 RegionBackendService 资源。在将请求转发到 backendService 之前，负载均衡器将应用作为此 backendServiceWeight 部分指定的任何相关 headerActions。 返回：成功 |
|
指定需要对选定的 backendService 生效的请求和响应标头的更改。此处指定的 headerAction 在封闭的 HttpRouteRule、PathMatcher 和 UrlMap 中的 headerAction 之前生效。 返回：成功 |
|
在将请求转发到 backendService 之前添加到匹配请求的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从请求中删除的标头的标头名称列表，然后再将请求转发到 backendService。 返回：成功 |
|
在将响应发送回客户端之前添加到响应的标头。 返回：成功 |
|
标头的名称。 返回：成功 |
|
要添加的标头的值。 返回：成功 |
|
如果为 false，则 headerValue 将附加到标头中已存在的任何值。如果为 true，则 headerValue 将设置为标头，并丢弃为该标头设置的任何值。 返回：成功 |
|
需要从响应中删除的标头的标头名称列表，然后再将响应发送回客户端。 返回：成功 |
|
指定发送到后端服务的流量比例，计算公式为 weight /（routeAction 中所有 weightedBackendService 权重的总和）。后端服务的选取仅针对新流量进行确定。一旦用户的请求被定向到某个后端服务，后续请求将根据后端服务的会话关联策略发送到同一个后端服务。 该值必须介于 0 和 1000 之间。 返回：成功 |
|
如果匹配此规则，则将流量定向到的区域后端服务资源。如果额外指定了 routeAction，则在将请求发送到后端之前，将生效高级路由操作，例如 URL 重写等。但是，如果指定了 service，则 routeAction 不能包含任何 weightedBackendService。反之，如果 routeAction 指定了任何 weightedBackendServices，则不能指定 service。只能设置 urlRedirect、service 或 routeAction.weightedBackendService 中的一个。 返回：成功 |
|
当匹配此规则时，请求将重定向到 urlRedirect 指定的 URL。如果指定了 urlRedirect，则不能设置 service 或 routeAction。 返回：成功 |
|
将在重定向响应中使用的主机，而不是请求中提供的那个主机。值必须介于 1 到 255 个字符之间。 返回：成功 |
|
如果设置为 true，则重定向请求中的 URL 方案将设置为 https。 如果设置为 false，则重定向请求的 URL 方案将保持与请求的 URL 方案相同。这只能设置为在 TargetHttpProxy 中使用的 UrlMap。不允许为 TargetHttpsProxy 将此设置为 true。默认设置为 false。 返回：成功 |
|
将在重定向响应中使用的路径，而不是请求中提供的路径。pathRedirect 不能与 prefixRedirect 一起提供。只提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。 该值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
替换 HttpRouteRuleMatch 中指定的 prefixMatch 的前缀，保留 URL 的其余部分，然后再重定向请求。prefixRedirect 不能与 pathRedirect 一起提供。只提供一个或都不提供。如果两者都不提供，则将使用原始请求的路径进行重定向。该值必须介于 1 和 1024 个字符之间。 返回：成功 |
|
此重定向操作使用的 HTTP 状态代码。支持的值包括：* MOVED_PERMANENTLY_DEFAULT，这是默认值，对应于 301。 * FOUND，对应于 302。 * SEE_OTHER，对应于 303。 * TEMPORARY_REDIRECT，对应于 307。在这种情况下，请求方法将被保留。 * PERMANENT_REDIRECT，对应于 308。在这种情况下，请求方法将被保留。 返回：成功 |
|
如果设置为 true，则在重定向请求之前，将删除原始 URL 的任何伴随查询部分。如果设置为 false，则将保留原始 URL 的查询部分。默认值为 false。 返回：成功 |
|
URL 地图所在的区域的引用。 返回：成功 |
|
预期 URL 映射的列表。只有在所有测试用例都通过的情况下，更新此 UrlMap 的请求才会成功。 返回：成功 |
|
此测试用例的描述。 返回：成功 |
|
URL 的主机部分。 返回：成功 |
|
URL 的路径部分。 返回：成功 |
|
给定 URL 应映射到的预期区域后端服务资源的引用。 返回：成功 |