google.cloud.gcp_compute_backend_service_info 模块 – 收集 GCP BackendService 的信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_compute_backend_service_info。

注意

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

概要

  • 收集 GCP BackendService 的信息

要求

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

  • 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 请求的 User Agent 字符串。

filters

列表 / elements=字符串

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

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

project

字符串

要使用的 Google Cloud Platform 项目。

scopes

列表 / elements=字符串

要使用的作用域数组

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 backend service
  gcp_compute_backend_service_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

复杂

资源列表

返回： 始终

affinityCookieTtlSec

整数

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

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

返回： 成功

backends

复杂

为该 BackendService 提供服务的后端集。

返回： 成功

balancingMode

字符串

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

对于全局 HTTP(S) 或 TCP/SSL 负载均衡，默认值为 UTILIZATION。有效值包括 UTILIZATION、RATE（对于 HTTP(S)）和 CONNECTION（对于 TCP/SSL）。

返回： 成功

capacityScaler

字符串

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

默认值为 1，表示该组将服务其配置容量的 100%（取决于 balancingMode）。设置为 0 表示该组已完全耗尽，提供的可用容量为 0%。有效范围为 [0.0,1.0]。

返回： 成功

description

字符串

此资源的可选描述。

创建资源时提供此属性。

返回： 成功

group

字符串

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

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

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

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

返回： 成功

maxConnections

整数

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

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

返回： 成功

maxConnectionsPerEndpoint

整数

单个后端网络端点可以处理的最大并发连接数。这用于计算组的容量。可以与 CONNECTION 或 UTILIZATION 负载均衡模式一起使用。

对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerEndpoint 中的一个。

返回： 成功

maxConnectionsPerInstance

整数

单个后端实例可以处理的最大并发连接数。这用于计算组的容量。可以与 CONNECTION 或 UTILIZATION 负载均衡模式一起使用。

对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerInstance 中的一个。

返回： 成功

maxRate

整数

该组的最大每秒请求数 (RPS)。

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

返回： 成功

maxRatePerEndpoint

字符串

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

返回： 成功

maxRatePerInstance

字符串

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

返回： 成功

maxUtilization

字符串

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

返回： 成功

cdnPolicy

复杂

此后端服务的 Cloud CDN 配置。

返回： 成功

cacheKeyPolicy

复杂

此 CdnPolicy 的 CacheKeyPolicy。

返回： 成功

includeHost

布尔值

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

返回： 成功

includeProtocol

布尔值

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

返回： 成功

includeQueryString

布尔值

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

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

返回： 成功

queryStringBlacklist

列表 / elements=字符串

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

将包含所有其他参数。请指定 query_string_whitelist 或 query_string_blacklist 中的一个，而不是两者都指定。

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

返回： 成功

queryStringWhitelist

列表 / elements=字符串

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

将排除所有其他参数。请指定 query_string_whitelist 或 query_string_blacklist 中的一个，而不是两者都指定。

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

返回： 成功

cacheMode

字符串

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

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

返回： 成功

clientTtl

整数

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

返回： 成功

defaultTtl

整数

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

返回： 成功

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 指定为值，并且不能多次指定同一状态代码。

返回： 成功

ttl

整数

缓存具有相应状态代码的响应的 TTL（以秒为单位）。允许的最大值为 1800 秒（30 分钟），请注意，不常访问的对象可能会在定义的 TTL 之前从缓存中逐出。

返回： 成功

serveWhileStale

整数

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

返回： 成功

signedUrlCacheMaxAgeSec

整数

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

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

返回： 成功

circuitBreakers

复杂

控制与后端服务连接量的设置。仅当 load_balancing_scheme 设置为 INTERNAL_SELF_MANAGED 时，此字段才适用。

返回： 成功

maxConnections

整数

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

默认为 1024。

返回： 成功

maxPendingRequests

整数

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

默认为 1024。

返回： 成功

maxRequests

整数

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

默认为 1024。

返回： 成功

maxRequestsPerConnection

整数

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

返回： 成功

maxRetries

整数

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

默认为 3。

返回： 成功

connectionDraining

复杂

连接耗尽的设置。

返回： 成功

drainingTimeoutSec

整数

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

返回： 成功

consistentHash

复杂

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

返回： 成功

httpCookie

复杂

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

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

返回： 成功

name

字符串

Cookie 的名称。

返回： 成功

路径

字符串

要为 Cookie 设置的路径。

返回： 成功

ttl

复杂

Cookie 的生命周期。

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

以秒为单位的时间跨度。

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

返回： 成功

httpHeaderName

字符串

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

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

返回： 成功

minimumRingSize

整数

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

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

默认为 1024。

返回： 成功

creationTimestamp

字符串

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

返回： 成功

customRequestHeaders

列表 / elements=字符串

HTTP/S 负载均衡器应添加到代理请求中的标头。

返回： 成功

customResponseHeaders

列表 / elements=字符串

HTTP/S 负载均衡器应添加到代理响应中的标头。

返回： 成功

description

字符串

此资源的可选描述。

返回： 成功

enableCDN

布尔值

如果为 true，则为此后端服务启用 Cloud CDN。

返回： 成功

fingerprint

字符串

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

返回： 成功

healthChecks

列表 / elements=字符串

用于为此后端服务进行运行状况检查的 HttpHealthCheck 或 HttpsHealthCheck 资源的 URL 集。当前最多可以指定一个运行状况检查。

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

对于内部负载均衡，必须指定 HealthCheck 资源的 URL。

返回： 成功

iap

复杂

用于启用 Cloud Identity Aware Proxy 的设置。

返回： 成功

enabled

布尔值

启用 IAP。

返回： 成功

oauth2ClientId

字符串

IAP 的 OAuth2 客户端 ID。

返回： 成功

oauth2ClientSecret

字符串

IAP 的 OAuth2 客户端密钥。

返回： 成功

oauth2ClientSecretSha256

字符串

IAP 的 OAuth2 客户端密钥 SHA-256。

返回： 成功

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

返回： 成功

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])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是破折号、小写字母或数字，但最后一个字符不能是破折号。

返回： 成功

outlierDetection（异常检测）

复杂

控制从负载均衡池中驱逐不健康主机的设置。

此字段仅在 load_balancing_scheme 设置为 INTERNAL_SELF_MANAGED 时适用。

返回： 成功

baseEjectionTime（基本驱逐时间）

复杂

主机被驱逐的基本时间。实际时间等于基本时间乘以主机被驱逐的次数。默认为 30000 毫秒或 30 秒。

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

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

返回： 成功

consecutiveErrors（连续错误）

整数

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

默认为 5。

返回： 成功

consecutiveGatewayFailure（连续网关故障）

整数

在发生连续网关故障驱逐之前，连续网关故障（502、503、504 状态或映射到其中一个状态代码的连接错误）的次数。默认为 5。

返回： 成功

enforcingConsecutiveErrors（强制执行连续错误）

整数

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

返回： 成功

enforcingConsecutiveGatewayFailure（强制执行连续网关故障）

整数

通过连续网关故障检测到异常状态时，主机将被实际驱逐的百分比概率。此设置可用于禁用驱逐或缓慢增加驱逐。默认为 0。

返回： 成功

enforcingSuccessRate（强制执行成功率）

整数

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

返回： 成功

interval（间隔）

复杂

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

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

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

返回： 成功

maxEjectionPercent（最大驱逐百分比）

整数

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

返回： 成功

successRateMinimumHosts（成功率最少主机数）

整数

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

返回： 成功

successRateRequestVolume（成功率请求量）

整数

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

返回： 成功

successRateStdevFactor（成功率标准差因子）

整数

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

返回： 成功

portName（端口名称）

字符串

后端端口的名称。相同的名称应出现在此服务引用的实例组中。当负载均衡方案为 EXTERNAL 时是必需的。

返回： 成功

protocol（协议）

字符串

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

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

返回： 成功

securityPolicy（安全策略）

字符串

与此后端服务关联的安全策略。

返回： 成功

sessionAffinity（会话亲和性）

字符串

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

返回： 成功

timeoutSec（超时秒数）

整数

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

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)