google.cloud.gcp_compute_region_backend_service_info 模块 – 收集 GCP RegionBackendService 的信息
注意
此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定： google.cloud.gcp_compute_region_backend_service_info。
注意
由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。有关更多信息，请参阅 讨论主题。
概要
收集 GCP RegionBackendService 的信息
要求
执行此模块的主机需要以下要求。
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 and filter2)。 |
|
要使用的 Google Cloud Platform 项目。 |
|
区域后端服务的所在区域的引用。 |
|
要使用的作用域数组 |
|
服务帐户 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 backend service
gcp_compute_region_backend_service_info:
region: us-central1
filters:
- name = test_object
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源列表 返回：始终 |
|
如果 session_affinity 为 GENERATED_COOKIE，则为 cookie 的生命周期（以秒为单位）。如果设置为 0，则 cookie 为非持久性 cookie，仅持续到浏览器会话结束（或等效）。TTL 的最大允许值为一天。 当负载均衡方案为 INTERNAL 时，此字段不使用。 返回：成功 |
|
为该 RegionBackendService 提供服务的 backends 集合。 返回：成功 |
|
指定此后端的平衡模式。 返回：成功 |
|
应用于组的最大服务容量（基于 UTILIZATION、RATE 或 CONNECTION）的乘数。 ~>**注意**: 此字段不能为内部区域后端服务 (default loadBalancingScheme) 设置，但对于非内部后端服务是必需的。所有后端的总 capacity_scaler 必须非零。 设置为 0 表示该组已完全清空，提供 0% 的可用容量。有效范围为 [0.0,1.0]。 返回：成功 |
|
此资源的可选描述。 创建资源时提供此属性。 返回：成功 |
|
此字段指定这是否是故障转移后端。可以为给定的 RegionBackendService 配置多个故障转移后端。 返回：成功 |
|
实例组或网络端点组资源的完全限定 URL。对于实例组，这定义了提供流量的实例列表。每个实例组中的成员虚拟机实例必须与实例组本身位于同一区域。后端服务的两个后端都不允许使用相同的实例组资源。 对于网络端点组，这定义了端点列表。网络端点组的所有端点都必须托管在与网络端点组位于同一区域的实例上。 后端服务不能混合使用实例组和网络端点组后端。 当 `load_balancing_scheme` 为 INTERNAL 时，仅支持实例组。 请注意，您必须使用完全限定的 URL（而不是部分 URL）来指定实例组或网络端点组资源。 返回：成功 |
|
组的最大并发连接数。可用于 CONNECTION 或 UTILIZATION 负载均衡模式。 不能为 INTERNAL 后端服务设置。 对于 CONNECTION 模式，必须根据组类型设置 maxConnections 或 maxConnectionsPerInstance 或 maxConnectionsPerEndpoint 之一。 返回：成功 |
|
单个后端网络端点可以处理的最大并发连接数。不能为 INTERNAL 后端服务设置。 这用于计算组的容量。可用于 CONNECTION 或 UTILIZATION 负载均衡模式。对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerEndpoint 之一。 返回：成功 |
|
单个后端实例可以处理的最大并发连接数。不能为 INTERNAL 后端服务设置。 这用于计算组的容量。 可用于 CONNECTION 或 UTILIZATION 负载均衡模式。 对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerInstance 之一。 返回：成功 |
|
组的最大每秒请求数 (RPS)。不能为 INTERNAL 后端服务设置。 可用于 RATE 或 UTILIZATION 负载均衡模式，但如果使用 RATE 模式，则必须设置。必须根据组类型设置 maxRate 或 maxRatePerInstance 或 maxRatePerEndpoint 之一。 返回：成功 |
|
单个后端网络端点可以处理的最大每秒请求数 (RPS)。这用于计算组的容量。可在任何负载均衡模式下使用。对于 RATE 模式，必须设置 maxRate 或 maxRatePerEndpoint 之一。不能为 INTERNAL 后端服务设置。 返回：成功 |
|
单个后端实例可以处理的最大每秒请求数 (RPS)。这用于计算组的容量。可在任何负载均衡模式下使用。对于 RATE 模式，必须设置 maxRate 或 maxRatePerInstance 之一。不能为 INTERNAL 后端服务设置。 返回：成功 |
|
在 balancingMode 为 UTILIZATION 时使用。此比率定义组的 CPU 利用率目标。有效范围为 [0.0, 1.0]。 不能为 INTERNAL 后端服务设置。 返回：成功 |
|
此 BackendService 的 Cloud CDN 配置。 返回：成功 |
|
此 CdnPolicy 的 CacheKeyPolicy。 返回：成功 |
|
如果为 true，则会分别缓存对不同主机的请求。 返回：成功 |
|
如果为 true，则会分别缓存 http 和 https 请求。 返回：成功 |
|
如果为 true，则根据 query_string_whitelist 和 query_string_blacklist 在缓存键中包含查询字符串参数。如果两者都没有设置，则将包含整个查询字符串。 如果为 false，则查询字符串将完全从缓存键中排除。 返回：成功 |
|
要在缓存键中排除的查询字符串参数名称。 所有其他参数都将包含在内。指定 query_string_whitelist 或 query_string_blacklist，但不能同时指定两者。 “&” 和 “=” 将被百分比编码，不会被视为分隔符。 返回：成功 |
|
要在缓存键中包含的查询字符串参数名称。 所有其他参数都将被排除。指定 query_string_whitelist 或 query_string_blacklist，但不能同时指定两者。 “&” 和 “=” 将被百分比编码，不会被视为分隔符。 返回：成功 |
|
指定此后端所有响应的缓存设置。 可能的值为：USE_ORIGIN_HEADERS、FORCE_CACHE_ALL 和 CACHE_ALL_STATIC。 返回：成功 |
|
指定此来源提供的缓存内容的最大允许 TTL。 返回：成功 |
|
为没有现有有效 TTL（max-age 或 s-max-age）的响应指定此来源提供的缓存内容的默认 TTL。 返回：成功 |
|
指定此来源提供的缓存内容的最大允许 TTL。 返回：成功 |
|
负缓存允许设置每个状态代码的 TTL，以便对常见的错误或重定向应用细粒度的缓存。 返回：成功 |
|
为指定的 HTTP 状态代码设置缓存 TTL。必须启用 negativeCaching 才能配置 negativeCachingPolicy。 省略策略并启用 negativeCaching 将使用 Cloud CDN 的默认缓存 TTL。 返回：成功 |
|
要针对其定义 TTL 的 HTTP 状态代码。只能将 HTTP 状态代码 300、301、308、404、405、410、421、451 和 501 指定为值，并且您不能多次指定状态代码。 返回：成功 |
|
在使用来源重新验证内容时，或在刷新缓存时遇到错误时，提供来自缓存的现有内容（如果可用）。 返回：成功 |
|
对签名 URL 请求的响应被视为新鲜的最大秒数，默认为 1 小时 (3600 秒)。在此时间段之后，将在提供响应之前重新验证响应。 在提供对签名 URL 请求的响应时，Cloud CDN 将在内部表现得好像来自此后端的全部响应都具有“Cache-Control: public, max-age=[TTL]”标头一样，而不管任何现有的 Cache-Control 标头如何。响应中提供的实际标头不会更改。 返回：成功 |
|
控制与后端服务的连接量的设置。此字段仅在 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时适用。 返回：成功 |
|
到后端集群的最大连接数。 默认为 1024。 返回：成功 |
|
到后端集群的待处理请求的最大数量。 默认为 1024。 返回：成功 |
|
到后端集群的并行请求的最大数量。 默认为 1024。 返回：成功 |
|
单个后端连接的最大请求数。此参数受 HTTP/1.1 和 HTTP/2 实现的遵守。如果未指定，则没有限制。将此参数设置为 1 将有效禁用保持活动。 返回：成功 |
|
到后端集群的并行重试的最大次数。 默认为 3。 返回：成功 |
|
连接排空设置。 返回：成功 |
|
实例将被排空的时间（不接受新连接，但仍努力完成已启动的任务）。 返回：成功 |
|
基于一致性哈希的负载均衡可用于基于 HTTP 标头、Cookie 或其他属性提供软会话关联。此负载均衡策略仅适用于 HTTP 连接。当一个或多个主机从目标服务中添加/删除时，对特定目标主机的关联将丢失。此字段指定控制一致性哈希的参数。 仅当以下所有条件都为真时，此字段才适用：* `load_balancing_scheme` 设置为 INTERNAL_MANAGED * `protocol` 设置为 HTTP、HTTPS 或 HTTP2 * `locality_lb_policy` 设置为 MAGLEV 或 RING_HASH。 返回：成功 |
|
哈希基于 HTTP Cookie。此字段描述将用作一致性哈希负载均衡器的哈希键的 HTTP Cookie。如果 Cookie 不存在，则将生成它。 如果 sessionAffinity 设置为 HTTP_COOKIE，则此字段适用。 返回：成功 |
|
Cookie 的名称。 返回：成功 |
|
为 Cookie 设置的路径。 返回：成功 |
|
Cookie 的生命周期。 返回：成功 |
|
以纳秒分辨率表示的几分之一秒的时间跨度。小于一秒的持续时间用 0 秒字段和正纳秒字段表示。必须介于 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为单位的时间跨度。 必须介于 0 到 315,576,000,000（含）之间。 返回：成功 |
|
基于指定标头字段的值的哈希。 如果 sessionAffinity 设置为 HEADER_FIELD，则此字段适用。 返回：成功 |
|
哈希环要使用的虚拟节点的最小数量。 较大的环尺寸会导致更细粒度的负载分配。如果负载均衡池中的主机数量大于环尺寸，则每个主机将分配一个虚拟节点。 默认为 1024。 返回：成功 |
|
以 RFC3339 文本格式表示的创建时间戳。 返回：成功 |
|
此资源的可选描述。 返回：成功 |
|
如果为 true，则为此 RegionBackendService 启用 Cloud CDN。 返回：成功 |
|
故障转移策略。 返回：成功 |
|
在故障转移或故障恢复时，此字段指示是否将遵守连接排空。将其设置为 true 会产生以下效果：不会排空到旧活动池的连接。对新活动池的连接使用 10 分钟的超时（当前固定）。设置为 false 会产生以下效果：旧连接和新连接都将具有 10 分钟的排空超时。 只有在协议为 TCP 时才能将其设置为 true。 默认为 false。 返回：成功 |
|
此选项仅在主实例组和备份实例组中未检测到任何正常虚拟机时使用。设置为 true 时，将丢弃流量。设置为 false 时，新连接将通过主组中的所有虚拟机发送。 默认为 false。 返回：成功 |
|
此字段的值必须在 [0, 1] 范围内。如果主后端中正常虚拟机的比率等于或低于此数字，则到达负载均衡 IP 的流量将被定向到故障转移后端。 如果未设置“failoverRatio”或备份后端中的所有虚拟机都不正常，则流量将以“强制”模式定向回主后端，其中流量将尽力传播到正常的虚拟机，或者在没有虚拟机正常时传播到所有虚拟机。 此字段仅与 L4 负载均衡一起使用。 返回：成功 |
|
此资源的指纹。存储在此对象中的内容的哈希值。此字段用于乐观锁定。 返回：成功 |
|
用于检查此 RegionBackendService 的运行状况的 HealthCheck 资源的 URL 集。当前最多可以指定一个运行状况检查。 除非后端服务使用互联网或无服务器 NEG 作为后端，否则必须指定运行状况检查。 返回：成功 |
|
资源的唯一标识符。 返回：成功 |
|
指示此区域后端服务将用于哪种类型的负载均衡。为一种类型的负载均衡创建的后端服务不能与其他类型一起使用。 返回：成功 |
|
在区域范围内使用的负载均衡算法。 可能的值为 - * ROUND_ROBIN - 这是一种简单的策略，其中每个正常后端都按循环顺序选择。 * LEAST_REQUEST - 选择两个随机的正常主机并选择活动请求较少的主机的算法。 * RING_HASH - 环/模哈希负载均衡器对后端实现一致性哈希。该算法具有以下特性：从 N 个主机集中添加/删除主机只会影响 1/N 的请求。 * RANDOM - 负载均衡器选择一个随机的正常主机。 * ORIGINAL_DESTINATION - 后端主机根据客户端连接元数据选择，即，在连接重定向到负载均衡器之前，连接将打开到与传入连接的目标地址相同的地址。 * MAGLEV - 用作环哈希负载均衡器的直接替代。 Maglev 不如环哈希稳定，但具有更快的表查找构建时间和主机选择时间。有关 Maglev 的更多信息，请参阅 https://ai.google/research/pubs/pub44824 此字段仅在 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时适用。 返回：成功 |
|
此字段表示此后端服务提供的负载均衡流量的日志记录选项。 如果启用了日志记录，则日志将导出到 Stackdriver。 返回：成功 |
|
是否为由此后端服务提供的负载均衡流量启用日志记录。 返回：成功 |
|
仅当为此后端服务启用了日志记录时，才能指定此字段。该字段的值必须在 [0, 1] 范围内。这配置了对负载均衡器的请求采样率，其中 1.0 表示报告所有已记录的请求，0.0 表示不报告任何已记录的请求。 默认值为 1.0。 返回：成功 |
|
资源名称。资源创建时由客户端提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是连字符、小写字母或数字，但最后一个字符不能是连字符。 返回：成功 |
|
此后端服务所属网络的 URL。 仅当负载均衡方案设置为 INTERNAL 时，才能指定此字段。 返回：成功 |
|
控制从负载均衡池中逐出不健康主机的设置。 仅当 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时，此字段才适用。 返回：成功 |
|
主机被弹出时间的基准时间。实际时间等于基准时间乘以主机被弹出的次数。默认为 30000 毫秒或 30 秒。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须在 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为分辨率表示的时间跨度。必须在 0 到 315,576,000,000（含）之间。 返回：成功 |
|
主机从连接池中弹出之前的错误次数。当通过 HTTP 访问后端主机时，5xx 返回代码构成错误。 默认为 5。 返回：成功 |
|
连续网关故障（502、503、504 状态或映射到这些状态代码之一的连接错误）的次数，此后将发生连续网关故障弹出。默认为 5。 返回：成功 |
|
当通过连续 5xx 检测到异常状态时，主机实际被弹出的概率百分比。此设置可用于禁用弹出或缓慢地将其增加。默认为 100。 返回：成功 |
|
当通过连续网关故障检测到异常状态时，主机实际被弹出的概率百分比。此设置可用于禁用弹出或缓慢地将其增加。默认为 0。 返回：成功 |
|
当通过成功率统计信息检测到异常状态时，主机实际被弹出的概率百分比。此设置可用于禁用弹出或缓慢地将其增加。默认为 100。 返回：成功 |
|
弹出扫描分析之间的时间间隔。这可能导致新的弹出以及主机返回服务。默认为 10 秒。 返回：成功 |
|
以纳秒分辨率表示的少于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须在 0 到 999,999,999（含）之间。 返回：成功 |
|
以秒为分辨率表示的时间跨度。必须在 0 到 315,576,000,000（含）之间。 返回：成功 |
|
后端服务负载均衡池中可以弹出的主机最大百分比。默认为 10%。 返回：成功 |
|
集群中必须具有足够的请求量才能检测成功率异常的主机数。如果主机数少于此设置，则不会对集群中的任何主机执行基于成功率统计信息的异常检测。默认为 5。 返回：成功 |
|
在一个间隔（如上所定义的间隔持续时间）内必须收集的总请求的最小数量，才能将此主机包含在基于成功率的异常检测中。如果数量低于此设置，则不会对该主机执行基于成功率统计信息的异常检测。默认为 100。 返回：成功 |
|
此因子用于确定成功率异常弹出弹出阈值。弹出阈值是平均成功率与该因子和平均成功率标准差的乘积之间的差值：平均值 - (标准差 * success_rate_stdev_factor)。此因子除以一千以获得双精度值。也就是说，如果所需的因子为 1.9，则运行时值应为 1900。默认为 1900。 返回：成功 |
|
后端实例组上的命名端口，表示与该组中后端虚拟机通信的端口。当 loadBalancingScheme 为 EXTERNAL、INTERNAL_MANAGED 或 INTERNAL_SELF_MANAGED 且后端为实例组时，这是必需的。命名端口必须在每个后端实例组上定义。如果后端是 NEGs，则此参数无意义。如果未提供，API 将设置默认值为“http”。 当 loadBalancingScheme 为 INTERNAL（内部 TCP/UDP 负载均衡）时，必须省略。 返回：成功 |
|
此 RegionBackendService 用于与后端通信的协议。 默认为 HTTP。**注意：**HTTP2 仅适用于测试版 HTTP/2 负载均衡器类型，如果与 GA API 一起使用，可能会导致错误。 返回：成功 |
|
区域后端服务的所在区域的引用。 返回：成功 |
|
要使用的会话关联类型。默认为 NONE。如果协议是 UDP，则会话关联不适用。 返回：成功 |
|
在将后端视为失败请求之前等待的时间（秒）。默认为 30 秒。有效范围是 [1, 86400]。 返回：成功 |