google.cloud.gcp_compute_region_backend_service 模块 – 创建一个 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。

注意

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

概要

  • 区域后端服务定义了一个区域范围的虚拟机组，该组将为负载平衡提供流量。

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

字符串

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

整数

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

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

auth_kind

字符串 / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

backends

列表 / 元素=字典

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

balancing_mode

字符串

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

一些有效的选项包括：“UTILIZATION”、“RATE”、“CONNECTION”

默认值： "CONNECTION"

capacity_scaler

字符串

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

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

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

description

字符串

此资源的可选描述。

创建资源时提供此属性。

failover

布尔值

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

选择

  • false

  • true

group

字符串 / 必需

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

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

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

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

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

max_connections

整数

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

不能为 INTERNAL 后端服务设置。

对于 CONNECTION 模式，必须设置 maxConnections 或 maxConnectionsPerInstance 或 maxConnectionsPerEndpoint 中的一个（根据组类型）。

max_connections_per_endpoint

整数

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

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

max_connections_per_instance

整数

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

这用于计算组的容量。

可以与 CONNECTION 或 UTILIZATION 负载均衡模式一起使用。

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

max_rate

整数

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

可以与 RATE 或 UTILIZATION 负载均衡模式一起使用，但如果使用 RATE 模式，则为必填项。必须设置 maxRate 或 maxRatePerInstance 或 maxRatePerEndpoint 中的一个（根据组类型）。

max_rate_per_endpoint

字符串

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

max_rate_per_instance

字符串

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

max_utilization

字符串

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

不能为 INTERNAL 后端服务设置。

cdn_policy

字典

此 BackendService 的 Cloud CDN 配置。

cache_key_policy

字典

此 CdnPolicy 的 CacheKeyPolicy。

include_host

布尔值

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

选择

  • false

  • true

include_protocol

布尔值

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

选择

  • false

  • true

include_query_string

布尔值

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

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

选择

  • false

  • true

query_string_blacklist

列表 / 元素=字符串

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

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

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

query_string_whitelist

列表 / 元素=字符串

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

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

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

cache_mode

字符串

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

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

一些有效的选择包括：“USE_ORIGIN_HEADERS”、“FORCE_CACHE_ALL”、“CACHE_ALL_STATIC”

client_ttl

整数

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

default_ttl

整数

为不具有现有有效 TTL（max-age 或 s-max-age）的响应指定此源提供的缓存内容的默认 TTL。

max_ttl

整数

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

negative_caching

布尔值

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

选择

  • false

  • true

negative_caching_policy

列表 / 元素=字典

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

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

code

整数

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

serve_while_stale

整数

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

signed_url_cache_max_age_sec

整数

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

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

默认值： 3600

circuit_breakers

字典

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

max_connections

整数

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

默认为 1024。

默认值： 1024

max_pending_requests

整数

到后端群集的最大待处理请求数。

默认为 1024。

默认值： 1024

max_requests

整数

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

默认为 1024。

默认值： 1024

max_requests_per_connection

整数

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

max_retries

整数

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

默认为 3。

默认值： 3

connection_draining

字典

连接耗尽的设置。

draining_timeout_sec

整数

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

默认值： 300

consistent_hash

字典

基于一致哈希的负载均衡可用于根据 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 之间（含）。

http_header_name

字符串

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

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

minimum_ring_size

整数

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

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

默认为 1024。

默认值： 1024

description

字符串

此资源的可选描述。

enable_cdn

布尔值

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

选择

  • false

  • true

env_type

字符串

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

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

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

failover_policy

字典

故障转移策略。

disable_connection_drain_on_failover

布尔值

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

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

默认为 false。

选择

  • false

  • true

drop_traffic_if_unhealthy

布尔值

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

默认为 false。

选择

  • false

  • true

failover_ratio

字符串

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

在未设置“failoverRatio”或备份后端中的所有虚拟机都不健康的情况下，流量将以“强制”模式定向回主后端，在这种模式下，流量将尽力分布到运行状况良好的虚拟机，或者在没有虚拟机运行状况良好时，分布到所有虚拟机。

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

health_checks

列表 / 元素=字符串

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

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

load_balancing_scheme

字符串

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

一些有效的选择包括：“EXTERNAL”、“INTERNAL”、“INTERNAL_MANAGED”

默认值： "INTERNAL"

locality_lb_policy

字符串

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

可能的值为 - * 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 时，此字段才适用。

一些有效的选择包括：“ROUND_ROBIN”、“LEAST_REQUEST”、“RING_HASH”、“RANDOM”、“ORIGINAL_DESTINATION”、“MAGLEV”

log_config

字典

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

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

enable

布尔值

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

选择

  • false

  • true

sample_rate

字符串

只有在此后端服务启用了日志记录时，才能指定此字段。该字段的值必须在 [0, 1] 范围内。这配置了负载均衡器请求的采样率，其中 1.0 表示所有记录的请求都会报告，而 0.0 表示不报告任何记录的请求。

默认值为 1.0。

name

字符串 / 必需

资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。

网络

字典

此后端服务所属的网络 URL。

仅当负载均衡方案设置为 INTERNAL 时，才能指定此字段。

此字段表示指向 GCP 中网络资源的链接。它可以通过两种方式指定。首先，您可以放置一个字典，其中键为“selfLink”，值为资源的 selfLink。或者，您可以在 gcp_compute_network 任务中添加 `register: name-of-resource`，然后将此网络字段设置为 “{{ name-of-resource }}”

异常检测

字典

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

此字段仅在 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时适用。

基本驱逐时间

字典

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

nanos

整数

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

seconds

整数 / 必需

以秒为分辨率的时间跨度。必须为 0 到 315,576,000,000（含）之间的整数。

连续错误

整数

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

默认为 5。

默认值： 5

连续网关故障

整数

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

默认值： 5

强制执行连续错误

整数

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

默认值： 100

强制执行连续网关故障

整数

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

强制执行成功率

整数

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

默认值： 100

间隔

字典

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

nanos

整数

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

seconds

整数 / 必需

以秒为分辨率的时间跨度。必须为 0 到 315,576,000,000（含）之间的整数。

最大驱逐百分比

整数

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

默认值： 10

成功率最小主机数

整数

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

默认值： 5

成功率请求量

整数

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

默认值： 100

成功率标准差因子

整数

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

默认值： 1900

端口名称

字符串

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

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

项目

字符串

要使用的 Google Cloud Platform 项目。

协议

字符串

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

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

一些有效的选项包括：“HTTP”、“HTTPS”、“HTTP2”、“SSL”、“TCP”、“UDP”、“GRPC”

区域

字符串 / 必需

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

作用域

列表 / 元素=字符串

要使用的作用域数组

服务帐户内容

jsonarg

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

服务帐户电子邮件

字符串

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

服务帐户文件

path

如果选择了 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

会话亲和性

字符串

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

一些有效的选项包括：“NONE”、“CLIENT_IP”、“CLIENT_IP_PORT_PROTO”、“CLIENT_IP_PROTO”、“GENERATED_COOKIE”、“HEADER_FIELD”、“HTTP_COOKIE”

状态

字符串

给定的对象是否应存在于 GCP 中

选择

  • "present" ← (默认)

  • "absent"

超时秒数

整数

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

备注

注意

  • API 参考：https://cloud.google.com/compute/docs/reference/latest/regionBackendServices

  • 内部 TCP/UDP 负载均衡：https://cloud.google.com/compute/docs/load-balancing/internal/

  • 对于身份验证，您可以使用 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: create a health check
  google.cloud.gcp_compute_health_check:
    name: "{{ resource_name }}"
    type: TCP
    tcp_health_check:
      port: 80
    check_interval_sec: 1
    timeout_sec: 1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck

- name: create a region backend service
  google.cloud.gcp_compute_region_backend_service:
    name: test_object
    region: us-central1
    health_checks:
    - "{{ healthcheck.selfLink }}"
    connection_draining:
      draining_timeout_sec: 10
    session_affinity: CLIENT_IP
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

通用返回值记录在此处：此处，以下是此模块独有的字段

键

描述

affinityCookieTtlSec

整数

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

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

返回： 成功

backends

复杂

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

返回： 成功

balancingMode

字符串

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

返回： 成功

capacityScaler

字符串

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

~>**注意**：此字段不能为 INTERNAL 区域后端服务设置（默认 loadBalancingScheme），但对于非 INTERNAL 后端服务是必需的。所有后端的总 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

列表 / 元素=字符串

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

将包含所有其他参数。请指定 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（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 连接。当从目标服务添加/删除一个或多个主机时，与特定目标主机的亲和性将丢失。此字段指定控制一致哈希的参数。

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

返回： 成功

httpCookie

复杂

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

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

返回： 成功

name

字符串

Cookie 的名称。

返回： 成功

path

字符串

为 Cookie 设置的路径。

返回： 成功

ttl

复杂

Cookie 的生存期。

返回： 成功

nanos

整数

在纳秒分辨率下的，秒的小数部分的时间跨度。小于一秒的持续时间用 0 秒字段和正的纳秒字段表示。必须在 0 到 999,999,999 之间（含）。

返回： 成功

seconds

整数

分辨率为秒的时间跨度。

必须在 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

列表 / 元素=字符串

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

除非后端服务使用 Internet 或无服务器 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 时，才能指定此字段。

返回： 成功

outlierDetection

复杂

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

此字段仅在 `load_balancing_scheme` 设置为 INTERNAL_MANAGED 且 `protocol` 设置为 HTTP、HTTPS 或 HTTP2 时适用。

返回： 成功

baseEjectionTime

复杂

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

返回： 成功

nanos

整数

以纳秒分辨率表示的秒的分数的时间跨度。小于一秒的持续时间用 0 `秒` 字段和一个正的 `纳秒` 字段表示。必须为 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。

返回： 成功

间隔

复杂

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

返回： 成功

nanos

整数

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

返回： 成功

seconds

整数

以秒为分辨率的时间跨度。必须为 0 到 315,576,000,000（含）之间的整数。

返回： 成功

maxEjectionPercent

整数

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

返回： 成功

successRateMinimumHosts

整数

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

返回： 成功

successRateRequestVolume

整数

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

返回： 成功

successRateStdevFactor

整数

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

返回： 成功

portName

字符串

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

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

返回： 成功

协议

字符串

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

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

返回： 成功

区域

字符串

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

返回： 成功

sessionAffinity

字符串

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

返回： 成功

timeoutSec

整数

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

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)