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

参数

参数

注释

access_token

字符串

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

auth_kind

字符串 / 必需

使用的凭证类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

字符串

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

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

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

filters

列表 / elements=string

筛选器值对的列表。 此处列出了可用的筛选器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。

列表中的每个附加筛选器将作为 AND 条件添加（筛选器 1 和筛选器 2）。

project

字符串

要使用的 Google Cloud Platform 项目。

region

字符串 / 必需

对区域后端服务所在的区域的引用。

scopes

列表 / elements=string

要使用的作用域数组

service_account_contents

jsonarg

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

service_account_email

字符串

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

service_account_file

路径

如果选择 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"

返回值

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

键

描述

资源

复杂

资源列表

返回： 始终

affinityCookieTtlSec

整数

如果 session_affinity 为 GENERATED_COOKIE，则 cookie 的生存期（以秒为单位）。 如果设置为 0，则 cookie 是非持久性的，并且仅持续到浏览器会话结束（或等效）。 TTL 的最大允许值是一天。

当负载均衡方案为 INTERNAL 时，不使用此字段。

返回： 成功

backends

复杂

为该 RegionBackendService 提供服务的后端集合。

返回： 成功

balancingMode

字符串

指定此后端的负载均衡模式。

返回： 成功

capacityScaler

字符串

应用于组的最大服务容量的乘数（基于 UTILIZATION、RATE 或 CONNECTION）。

~>**注意**：此字段不能为 INTERNAL 区域后端服务设置（默认 loadBalancingScheme），但对于非 INTERNAL 后端服务是必需的。所有后端的 total capacity_scaler 必须为非零。

设置为 0 表示组已完全耗尽，提供 0% 的可用容量。 有效范围为 [0.0,1.0]。

返回： 成功

description

字符串

此资源的可选描述。

创建资源时提供此属性。

返回： 成功

failover

布尔值

此字段指定这是否为故障转移后端。 可以为给定的 RegionBackendService 配置多个故障转移后端。

返回： 成功

group

字符串

实例组或网络端点组资源的完全限定 URL。 在实例组的情况下，这定义了为流量提供服务的实例列表。 来自每个实例组的成员虚拟机实例必须与实例组本身位于同一区域。 后端服务中不允许有两个后端使用相同的实例组资源。

对于网络端点组，这定义了端点列表。 网络端点组的所有端点都必须托管在与网络端点组位于同一区域的实例上。

后端服务不能混合使用实例组和网络端点组后端。

当 `load_balancing_scheme` 为 INTERNAL 时，仅支持实例组。

请注意，您必须使用完全限定的 URL 而不是部分 URL 来指定实例组或网络端点组资源。

返回： 成功

maxConnections

整数

该组的最大同时连接数。 可以与 CONNECTION 或 UTILIZATION 负载均衡模式一起使用。

不能为 INTERNAL 后端服务设置。

对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerInstance 或 maxConnectionsPerEndpoint 中的一个，具体取决于组类型。

返回： 成功

maxConnectionsPerEndpoint

整数

单个后端网络端点可以处理的最大并发连接数。不能为 INTERNAL 后端服务设置。

用于计算组的容量。可以在 CONNECTION 或 UTILIZATION 负载均衡模式中使用。对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerEndpoint。

返回： 成功

maxConnectionsPerInstance

整数

单个后端实例可以处理的最大并发连接数。不能为 INTERNAL 后端服务设置。

用于计算组的容量。

可以在 CONNECTION 或 UTILIZATION 负载均衡模式中使用。

对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerInstance。

返回： 成功

maxRate

整数

组的最大每秒请求数 (RPS)。不能为 INTERNAL 后端服务设置。

可以在 RATE 或 UTILIZATION 负载均衡模式中使用，但如果使用 RATE 模式则为必选项。必须设置 maxRate 或 maxRatePerInstance 或 maxRatePerEndpoint 中的一个，具体取决于组类型。

返回： 成功

maxRatePerEndpoint

字符串

单个后端网络端点可以处理的最大每秒请求数 (RPS)。用于计算组的容量。可以在任何负载均衡模式中使用。对于 RATE 模式，必须设置 maxRate 或 maxRatePerEndpoint。不能为 INTERNAL 后端服务设置。

返回： 成功

maxRatePerInstance

字符串

单个后端实例可以处理的最大每秒请求数 (RPS)。用于计算组的容量。可以在任何负载均衡模式中使用。对于 RATE 模式，必须设置 maxRate 或 maxRatePerInstance。不能为 INTERNAL 后端服务设置。

返回： 成功

maxUtilization

字符串

当 balancingMode 为 UTILIZATION 时使用。此比率定义组的 CPU 利用率目标。有效范围是 [0.0, 1.0]。

不能为 INTERNAL 后端服务设置。

返回： 成功

cdnPolicy

复杂

此 BackendService 的 Cloud CDN 配置。

返回： 成功

cacheKeyPolicy

复杂

此 CdnPolicy 的 CacheKeyPolicy。

返回： 成功

includeHost

布尔值

如果为 true，则对不同主机的请求将单独缓存。

返回： 成功

includeProtocol

布尔值

如果为 true，则 http 和 https 请求将单独缓存。

返回： 成功

includeQueryString

布尔值

如果为 true，则根据 query_string_whitelist 和 query_string_blacklist 在缓存键中包含查询字符串参数。如果两者都未设置，则将包含整个查询字符串。

如果为 false，则查询字符串将完全从缓存键中排除。

返回： 成功

queryStringBlacklist

列表 / elements=string

要在缓存键中排除的查询字符串参数的名称。

将包含所有其他参数。指定 query_string_whitelist 或 query_string_blacklist，但不能同时指定两者。

“&”和“=”将进行百分比编码，不会被视为分隔符。

返回： 成功

queryStringWhitelist

列表 / elements=string

要在缓存键中包含的查询字符串参数的名称。

将排除所有其他参数。指定 query_string_whitelist 或 query_string_blacklist，但不能同时指定两者。

“&”和“=”将进行百分比编码，不会被视为分隔符。

返回： 成功

cacheMode

字符串

指定此后端所有响应的缓存设置。

可能的值为：USE_ORIGIN_HEADERS、FORCE_CACHE_ALL 和 CACHE_ALL_STATIC 。

返回： 成功

clientTtl

整数

指定此源站提供的缓存内容的最大允许 TTL。

返回： 成功

defaultTtl

整数

对于没有现有有效 TTL（max-age 或 s-max-age）的响应，指定此源站提供的缓存内容的默认 TTL。

返回： 成功

maxTtl

整数

指定此源站提供的缓存内容的最大允许 TTL。

返回： 成功

negativeCaching

布尔值

负缓存允许设置每个状态代码的 TTL，以便为常见错误或重定向应用细粒度的缓存。

返回： 成功

negativeCachingPolicy

复杂

为指定的 HTTP 状态代码设置缓存 TTL。必须启用 negativeCaching 才能配置 negativeCachingPolicy。

省略策略并保持启用 negativeCaching 将使用 Cloud CDN 的默认缓存 TTL。

返回： 成功

code

整数

要定义 TTL 的 HTTP 状态代码。只有 HTTP 状态代码 300、301、308、404、405、410、421、451 和 501 可以指定为值，并且您不能多次指定相同的状态代码。

返回： 成功

serveWhileStale

整数

在重新验证源站内容时，或者在刷新缓存时遇到错误时，从缓存中提供现有内容（如果可用）。

返回： 成功

signedUrlCacheMaxAgeSec

整数

签名 URL 请求的响应被视为新鲜的最大秒数，默认为 1 小时（3600 秒）。在此时间段之后，将在提供之前重新验证响应。

在为签名 URL 请求提供响应时，Cloud CDN 将在内部表现为好像来自此后端的所有响应都具有“Cache-Control: public, max-age=[TTL]”标头，而不管任何现有的 Cache-Control 标头如何。响应中提供的实际标头不会更改。

返回： 成功

circuitBreakers

复杂

控制到后端服务的连接量的设置。仅当 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 并且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时，此字段才适用。

返回： 成功

maxConnections

整数

到后端群集的最大连接数。

默认为 1024。

返回： 成功

maxPendingRequests

整数

到后端群集的最大挂起请求数。

默认为 1024。

返回： 成功

maxRequests

整数

到后端群集的最大并行请求数。

默认为 1024。

返回： 成功

maxRequestsPerConnection

整数

单个后端连接的最大请求数。HTTP/1.1 和 HTTP/2 实现都遵守此参数。如果未指定，则没有限制。将此参数设置为 1 将有效地禁用保持活动状态。

返回： 成功

maxRetries

整数

到后端群集的最大并行重试次数。

默认为 3。

返回： 成功

connectionDraining

复杂

连接耗尽的设置。

返回： 成功

drainingTimeoutSec

整数

实例耗尽的时间（不接受新连接，但仍会完成已启动的工作）。

返回： 成功

consistentHash

复杂

基于一致哈希的负载均衡可用于根据 HTTP 标头、cookie 或其他属性提供软会话亲和性。此负载均衡策略仅适用于 HTTP 连接。当从目标服务中添加/删除一个或多个主机时，与特定目标主机的亲和性将丢失。此字段指定控制一致哈希的参数。

仅当以下所有条件都为 true 时，此字段才适用 - * `load_balancing_scheme` 设置为 INTERNAL_MANAGED * `protocol` 设置为 HTTP、HTTPS 或 HTTP2 * `locality_lb_policy` 设置为 MAGLEV 或 RING_HASH 。

返回： 成功

httpCookie

复杂

哈希基于 HTTP Cookie。此字段描述一个 HTTP cookie，它将用作一致哈希负载均衡器的哈希键。如果 cookie 不存在，则会生成该 cookie。

如果 sessionAffinity 设置为 HTTP_COOKIE，则此字段适用。

返回： 成功

name

字符串

cookie 的名称。

返回： 成功

路径

字符串

为 cookie 设置的路径。

返回： 成功

ttl

复杂

cookie 的生存期。

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

以秒为单位的时间跨度。

必须介于 0 到 315,576,000,000 之间（含 0 和 315,576,000,000）。

返回： 成功

httpHeaderName

字符串

基于指定标头字段值的哈希。

如果 sessionAffinity 设置为 HEADER_FIELD，则此字段适用。

返回： 成功

minimumRingSize

整数

用于哈希环的最小虚拟节点数。

较大的环大小会导致更精细的负载分配。如果负载均衡池中的主机数大于环大小，则每个主机将被分配一个虚拟节点。

默认为 1024。

返回： 成功

creationTimestamp

字符串

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

返回： 成功

description

字符串

此资源的可选描述。

返回： 成功

enableCDN

布尔值

如果为 true，则为此 RegionBackendService 启用 Cloud CDN。

返回： 成功

failoverPolicy

复杂

故障转移策略。

返回： 成功

disableConnectionDrainOnFailover

布尔值

在故障转移或故障恢复时，此字段指示是否将遵循连接耗尽。将其设置为 true 具有以下效果：不会耗尽到旧活动池的连接。到新活动池的连接使用 10 分钟的超时时间（当前固定）。将其设置为 false 具有以下效果：旧连接和新连接的耗尽超时时间均为 10 分钟。

仅当协议为 TCP 时，才能将其设置为 true。

默认值为 false。

返回： 成功

dropTrafficIfUnhealthy

布尔值

仅当在主实例组和备份实例组中都未检测到运行状况良好的虚拟机时，才使用此选项。设置为 true 时，会丢弃流量。设置为 false 时，新连接将发送到主组中的所有虚拟机。

默认值为 false。

返回： 成功

failoverRatio

字符串

该字段的值必须在 [0, 1] 之间。如果主后端中运行状况良好的虚拟机的比率等于或低于此数字，则到达负载均衡 IP 的流量将定向到故障转移后端。

如果未设置“failoverRatio”或备份后端中的所有虚拟机都运行状况不佳，则流量将以“强制”模式定向回主后端，其中流量将尽力分配到运行状况良好的虚拟机，或者在没有虚拟机运行状况良好时分配到所有虚拟机。

此字段仅用于 L4 负载均衡。

返回： 成功

fingerprint

字符串

此资源的指纹。存储在此对象中的内容的哈希值。此字段用于乐观锁定。

返回： 成功

healthChecks

列表 / elements=string

用于运行状况检查此 RegionBackendService 的 HealthCheck 资源的 URL 集。目前，最多可以指定一个运行状况检查。

除非后端服务使用互联网或无服务器 NEG 作为后端，否则必须指定运行状况检查。

返回： 成功

id

整数

资源的唯一标识符。

返回： 成功

loadBalancingScheme

字符串

指示此区域后端服务将用于哪种负载均衡。为一种类型的负载均衡创建的后端服务不能与其他类型一起使用。

返回： 成功

localityLbPolicy

字符串

在区域范围内使用的负载均衡算法。

可能的值为 - * ROUND_ROBIN - 这是一种简单的策略，其中按轮循顺序选择每个运行状况良好的后端。

* LEAST_REQUEST - 一种 `1` 算法，它选择两个随机的运行状况良好的主机，并选择活动请求较少的主机。

* 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 时，此字段才适用。

返回： 成功

logConfig

复杂

此字段表示此后端服务提供的负载均衡器流量的日志记录选项。

如果启用日志记录，则日志将导出到 Stackdriver。

返回： 成功

enable

布尔值

是否为此后端服务提供的负载均衡器流量启用日志记录。

返回： 成功

sampleRate

字符串

仅当为此后端服务启用日志记录时，才能指定此字段。该字段的值必须在 [0, 1] 之间。这将配置负载均衡器的请求采样率，其中 1.0 表示报告所有记录的请求，而 0.0 表示不报告记录的请求。

默认值为 1.0。

返回： 成功

name

字符串

资源的名称。由客户端在创建资源时提供。名称长度必须为 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 秒。

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

以秒为单位的时间跨度。必须在 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回： 成功

连续错误

整数

主机从连接池中驱逐前的错误次数。当通过 HTTP 访问后端主机时，5xx 返回代码被视为错误。

默认为 5。

返回： 成功

连续网关失败

整数

发生连续网关失败驱逐之前的连续网关失败次数（502、503、504 状态或映射到这些状态代码之一的连接错误）。默认为 5。

返回： 成功

强制执行连续错误

整数

当通过连续的 5xx 检测到异常状态时，实际驱逐主机的可能性百分比。此设置可用于禁用驱逐或缓慢增加驱逐比例。默认为 100。

返回： 成功

强制执行连续网关失败

整数

当通过连续的网关失败检测到异常状态时，实际驱逐主机的可能性百分比。此设置可用于禁用驱逐或缓慢增加驱逐比例。默认为 0。

返回： 成功

强制执行成功率

整数

当通过成功率统计检测到异常状态时，实际驱逐主机的可能性百分比。此设置可用于禁用驱逐或缓慢增加驱逐比例。默认为 100。

返回： 成功

间隔

复杂

驱逐扫描分析之间的时间间隔。这可能导致新的驱逐以及主机恢复服务。默认为 10 秒。

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

以秒为单位的时间跨度。必须在 0 到 315,576,000,000 之间（包括 0 和 315,576,000,000）。

返回： 成功

最大驱逐百分比

整数

后端服务的负载均衡池中可被驱逐的主机的最大百分比。默认为 10%。

返回： 成功

成功率最少主机数

整数

集群中必须具有足够请求量才能检测成功率异常值的主机数。如果主机数小于此设置，则不会对集群中的任何主机执行通过成功率统计的异常值检测。默认为 5。

返回： 成功

成功率请求量

整数

在一个时间间隔内（由上面的间隔持续时间定义）必须收集的最小总请求数，才能将此主机纳入基于成功率的异常值检测。如果请求量低于此设置，则不会对该主机执行通过成功率统计的异常值检测。默认为 100。

返回： 成功

成功率标准差因子

整数

此因子用于确定成功率异常值驱逐的驱逐阈值。驱逐阈值是平均成功率与此因子和平均成功率标准差的乘积之间的差值：平均值 - （标准差 * 成功率标准差因子）。此因子除以 1000 得到一个双精度值。也就是说，如果所需的因子是 1.9，则运行时值应为 1900。默认为 1900。

返回： 成功

端口名称

字符串

后端实例组上的一个命名端口，表示与该组中后端虚拟机通信的端口。当 loadBalancingScheme 为 EXTERNAL、INTERNAL_MANAGED 或 INTERNAL_SELF_MANAGED 且后端是实例组时，此参数是必需的。必须在每个后端实例组上定义命名端口。如果后端是 NEG，则此参数没有意义。如果未给出，API 会将默认值设置为 “http”。

当 loadBalancingScheme 为 INTERNAL（内部 TCP/UDP 负载均衡）时，必须省略此参数。

返回： 成功

协议

字符串

此 RegionBackendService 用于与后端通信的协议。

默认值为 HTTP。**注意**：HTTP2 仅对 Beta HTTP/2 负载均衡器类型有效，如果与 GA API 一起使用可能会导致错误。

返回： 成功

region

字符串

对区域后端服务所在的区域的引用。

返回： 成功

会话亲和性

字符串

要使用的会话亲和性类型。默认值为 NONE。如果协议为 UDP，则不适用会话亲和性。

返回： 成功

超时秒数

整数

在将后端视为失败请求之前，等待后端多少秒。默认值为 30 秒。有效范围是 [1, 86400]。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)