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 请求的用户代理字符串。
filters 列表 / 元素=字符串	过滤器值对列表。此处列出了可用的过滤器 https://cloud.google.com/sdk/gcloud/reference/topic/filters。列表中的每个附加过滤器都将作为 AND 条件添加 (filter1 和 filter2)。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
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]。返回：成功
描述字符串	此资源的可选描述。创建资源时提供此属性。返回：成功
组字符串	实例组或网络端点组资源的完全限定 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 复杂类型	此 BackendService 的 Cloud CDN 配置。返回：成功
cacheKeyPolicy 复杂类型	此 CdnPolicy 的 CacheKeyPolicy。返回：成功
includeHost 布尔值	如果为 true，则对不同主机的请求将分别缓存。返回：成功
includeProtocol 布尔值	如果为 true，则 http 和 https 请求将分别缓存。返回：成功
includeQueryString 布尔值	如果为 true，则根据 query_string_whitelist 和 query_string_blacklist 在缓存键中包含查询字符串参数。如果两者都没有设置，则将包含整个查询字符串。如果为 false，则查询字符串将完全从缓存键中排除。返回：成功
queryStringBlacklist 列表 / 元素=字符串	要从缓存键中排除的查询字符串参数的名称。将包含所有其他参数。指定 query_string_whitelist 或 query_string_blacklist，不能同时指定两者。 “&” 和 “=” 将被百分比编码，不会被视为分隔符。返回：成功
queryStringWhitelist 列表 / 元素=字符串	要在缓存键中包含的查询字符串参数的名称。将排除所有其他参数。指定 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 不存在，则将生成它。如果 sessionAffinity 设置为 HTTP_COOKIE，则此字段适用。返回：成功
name 字符串	Cookie 的名称。返回：成功
路径字符串	为 Cookie 设置的路径。返回：成功
ttl 复杂类型	Cookie 的生命周期。返回：成功
nanos 整数	以纳秒分辨率表示的几分之一秒的时间跨度。小于一秒的持续时间用 0 秒字段和正 nanos 字段表示。必须介于 0 到 999,999,999（含）之间。返回：成功
seconds 整数	以秒为单位的时间跨度。必须介于 0 到 315,576,000,000（含）之间。返回：成功
httpHeaderName 字符串	基于指定标头字段的值的哈希。如果 sessionAffinity 设置为 HEADER_FIELD，则此字段适用。返回：成功
minimumRingSize 整数	用于哈希环的最小虚拟节点数。较大的环大小会导致更细粒度的负载分配。如果负载均衡池中的主机数量大于环大小，则每个主机将分配一个虚拟节点。默认为 1024。返回：成功
creationTimestamp 字符串	以 RFC3339 文本格式表示的创建时间戳。返回：成功
customRequestHeaders 列表 / 元素=字符串	HTTP/S 负载均衡器应添加到代理请求的标头。返回：成功
customResponseHeaders 列表 / 元素=字符串	HTTP/S 负载均衡器应添加到代理响应的标头。返回：成功
描述字符串	此资源的可选描述。返回：成功
enableCDN 布尔值	如果为 true，则为此 BackendService 启用 Cloud CDN。返回：成功
fingerprint 字符串	此资源的指纹。此对象中存储的内容的哈希值。此字段用于乐观锁。返回：成功
healthChecks 列表 / 元素=字符串	用于对此 BackendService 进行运行状况检查的 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 - 选择两个随机健康主机并选择活动请求较少的主机的算法。 * 环形哈希 (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 整数	以纳秒为单位表示的，小于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须在 0 到 999,999,999（含）之间。返回：成功
seconds 整数	以秒为单位表示的时间跨度。必须在 0 到 315,576,000,000（含）之间。返回：成功
consecutiveErrors 整数	主机从连接池中被逐出之前的错误次数。当通过 HTTP 访问后端主机时，5xx 返回码视为错误。默认为 5。返回：成功
consecutiveGatewayFailure 整数	连续网关失败（502、503、504 状态或映射到这些状态码之一的连接错误）的次数，之后会发生连续网关失败逐出。默认为 5。返回：成功
enforcingConsecutiveErrors 整数	检测到连续 5xx 导致异常状态时，主机实际被逐出的概率百分比。此设置可用于禁用逐出或缓慢地提高逐出率。默认为 100。返回：成功
enforcingConsecutiveGatewayFailure 整数	检测到连续网关故障导致异常状态时，主机实际被逐出的概率百分比。此设置可用于禁用逐出或缓慢地提高逐出率。默认为 0。返回：成功
enforcingSuccessRate 整数	检测到成功率统计信息导致异常状态时，主机实际被逐出的概率百分比。此设置可用于禁用逐出或缓慢地提高逐出率。默认为 100。返回：成功
interval 复杂类型	逐出扫描分析之间的时间间隔。这可能导致新的逐出以及主机返回服务。默认为 10 秒。返回：成功
nanos 整数	以纳秒为单位表示的，小于一秒的时间跨度。小于一秒的持续时间用 0 `seconds` 字段和正 `nanos` 字段表示。必须在 0 到 999,999,999（含）之间。返回：成功
seconds 整数	以秒为单位表示的时间跨度。必须在 0 到 315,576,000,000（含）之间。返回：成功
maxEjectionPercent 整数	后端服务负载均衡池中可以被逐出的主机最大百分比。默认为 10%。返回：成功
successRateMinimumHosts 整数	集群中必须具有足够的请求量才能检测成功率异常的主机数量。如果主机数量少于此设置，则不会对集群中的任何主机执行基于成功率统计信息的异常检测。默认为 5。返回：成功
successRateRequestVolume 整数	在一个间隔（如上所述的间隔持续时间定义）内必须收集的总请求的最小数量，才能将此主机包含在基于成功率的异常检测中。如果卷低于此设置，则不会对该主机执行基于成功率统计信息的异常检测。默认为 100。返回：成功
successRateStdevFactor 整数	此因子用于确定成功率异常逐出的逐出阈值。逐出阈值是平均成功率与该因子和平均成功率标准差的乘积之间的差值：平均值 - (标准差 * success_rate_stdev_factor)。此因子除以一千以获得双精度数。也就是说，如果所需的因子为 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)