google.cloud.gcp_compute_health_check 模块 – 创建 GCP 健康检查

注意

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

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

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参见要求。

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

注意

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

概要 

健康检查确定实例是否响应并能够执行工作。
它们是综合负载均衡配置的重要组成部分，因为它们能够监控负载均衡器后面的实例。
健康检查以指定的时间间隔轮询实例。连续多次探测未成功响应的实例将被标记为不健康。不会向不健康的实例发送新连接，但现有连接将继续。健康检查将继续轮询不健康的实例。如果一个实例后来连续多次成功响应探测，它将再次被标记为健康，并且可以接收新连接。
~>**注意**: 必须对基于目标池的网络负载均衡器使用旧版 HTTP(S) 健康检查。有关选择健康检查类型的更多信息，请参见[官方指南](https://cloud.google.com/load-balancing/docs/health-check-concepts#selecting_hc)。

要求 

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
check_interval_sec 整数	发送健康检查的频率（以秒为单位）。默认值为 5 秒。默认值: `5`
description 字符串	此资源的可选描述。在创建资源时提供此属性。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此项。这只会更改任何 API 请求的 User Agent 字符串。
grpc_health_check 字典	一个嵌套的对象资源。
grpc_service_name 字符串	健康检查的 gRPC 服务名称。按照惯例，grpcServiceName 的值具有以下含义：- 空的 serviceName 表示后端所有服务的总体状态。非空的 serviceName 表示 gRPC 服务的运行状况，由服务的所有者定义。 grpcServiceName 只能是 ASCII。
port 整数	健康检查请求的端口号。如果未设置 portName 和 portSpecification 或 port_specification 为 USE_FIXED_PORT，则必须指定。有效值为 1 到 65535。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 gRPC 健康检查遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
healthy_threshold 整数	一个至今不健康的实例将在连续多次成功后被标记为健康。默认值为 2。默认值: `2`
http2_health_check 字典	一个嵌套的对象资源。
host 字符串	HTTP2 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。
port 整数	HTTP2 健康检查请求的 TCP 端口号。默认值为 443。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTP2 健康检查遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
proxy_header 字符串	指定在向后端发送数据之前要附加的代理标头的类型。一些有效选项包括：“NONE”、“PROXY_V1” 默认值: `"NONE"`
request_path 字符串	HTTP2 健康检查请求的请求路径。默认值为 /。默认值: `"/"`
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。
http_health_check 字典	一个嵌套的对象资源。
host 字符串	HTTP 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。
port 整数	HTTP 健康检查请求的 TCP 端口号。默认值为 80。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTP 健康检查遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
proxy_header 字符串	指定在向后端发送数据之前要附加的代理标头的类型。一些有效选项包括：“NONE”、“PROXY_V1” 默认值: `"NONE"`
request_path 字符串	HTTP 健康检查请求的请求路径。默认值为 /。默认值: `"/"`
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。
https_health_check 字典	一个嵌套的对象资源。
host 字符串	HTTPS 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。
port 整数	HTTPS 健康检查请求的 TCP 端口号。默认值为 443。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTPS 健康检查遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
proxy_header 字符串	指定在向后端发送数据之前要附加的代理标头的类型。一些有效选项包括：“NONE”、“PROXY_V1” 默认值: `"NONE"`
request_path 字符串	HTTPS 健康检查请求的请求路径。默认值为 /。默认值: `"/"`
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。
log_config 字典	在此健康检查上配置日志记录。
enable 布尔值	指示是否导出日志。默认值为 false，这意味着不会进行任何健康检查日志记录。选项 `false` ← (默认) `true`
name 字符串 / 必需	资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes list / elements=string	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file path	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
ssl_health_check 字典	一个嵌套的对象资源。
port 整数	SSL 健康检查请求的 TCP 端口号。默认值为 443。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，SSL 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
proxy_header 字符串	指定在向后端发送数据之前要附加的代理标头的类型。一些有效选项包括：“NONE”、“PROXY_V1” 默认值: `"NONE"`
request 字符串	一旦建立 SSL 连接要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅连接建立就表示健康。请求数据只能是 ASCII。
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。
state 字符串	给定对象是否应存在于 GCP 中选项 `"present"` ← (默认) `"absent"`
tcp_health_check 字典	一个嵌套的对象资源。
port 整数	TCP 健康检查请求的 TCP 端口号。默认值为 443。
port_name 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。
port_specification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，TCP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。一些有效选项包括：“USE_FIXED_PORT”、“USE_NAMED_PORT”、“USE_SERVING_PORT”
proxy_header 字符串	指定在向后端发送数据之前要附加的代理标头的类型。一些有效选项包括：“NONE”、“PROXY_V1” 默认值: `"NONE"`
request 字符串	一旦建立 TCP 连接要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅连接建立就表示健康。请求数据只能是 ASCII。
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。
timeout_sec aliases: timeout_seconds 整数	在声明失败之前等待多长时间（以秒为单位）。默认值为 5 秒。timeoutSec 的值大于 checkIntervalSec 是无效的。默认值: `5`
type 字符串	指定 healthCheck 的类型，可以是 TCP、SSL、HTTP 或 HTTPS。如果未指定，则默认为 TCP。必须指定一个与协议相关的健康检查字段，且该字段必须与 type 字段匹配。一些有效的选择包括：“TCP”、“SSL”、“HTTP”、“HTTPS”、“HTTP2”
unhealthy_threshold 整数	一个到目前为止健康的实例在连续失败这么多次后将被标记为不健康。默认值为 2。默认值: `2`

备注 

注意

API 参考：https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks
官方文档：https://cloud.google.com/load-balancing/docs/health-checks
对于身份验证，您可以使用 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: test_object
    type: TCP
    tcp_health_check:
      port_name: service-health
      request: ping
      response: pong
    healthy_threshold: 10
    timeout_sec: 2
    unhealthy_threshold: 5
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值 

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

键	描述
checkIntervalSec 整数	发送健康检查的频率（以秒为单位）。默认值为 5 秒。返回：成功
creationTimestamp 字符串	RFC3339 文本格式的创建时间戳。返回：成功
description 字符串	此资源的可选描述。在创建资源时提供此属性。返回：成功
grpcHealthCheck 复杂	一个嵌套的对象资源。返回：成功
grpcServiceName 字符串	健康检查的 gRPC 服务名称。按照惯例，grpcServiceName 的值具有以下含义：- 空的 serviceName 表示后端所有服务的总体状态。非空的 serviceName 表示 gRPC 服务的运行状况，由服务的所有者定义。 grpcServiceName 只能是 ASCII。返回：成功
port 整数	健康检查请求的端口号。如果未设置 portName 和 portSpecification 或 port_specification 为 USE_FIXED_PORT，则必须指定。有效值为 1 到 65535。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 gRPC 健康检查遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
healthyThreshold 整数	一个至今不健康的实例将在连续多次成功后被标记为健康。默认值为 2。返回：成功
http2HealthCheck 复杂	一个嵌套的对象资源。返回：成功
host 字符串	HTTP2 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。返回：成功
port 整数	HTTP2 健康检查请求的 TCP 端口号。默认值为 443。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTP2 健康检查遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
proxyHeader 字符串	指定在向后端发送数据之前要附加的代理标头的类型。返回：成功
requestPath 字符串	HTTP2 健康检查请求的请求路径。默认值为 /。返回：成功
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。返回：成功
httpHealthCheck 复杂	一个嵌套的对象资源。返回：成功
host 字符串	HTTP 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。返回：成功
port 整数	HTTP 健康检查请求的 TCP 端口号。默认值为 80。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTP 健康检查遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
proxyHeader 字符串	指定在向后端发送数据之前要附加的代理标头的类型。返回：成功
requestPath 字符串	HTTP 健康检查请求的请求路径。默认值为 /。返回：成功
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。返回：成功
httpsHealthCheck 复杂	一个嵌套的对象资源。返回：成功
host 字符串	HTTPS 健康检查请求中 host 标头的值。如果留空（默认值），将使用执行此健康检查的公共 IP。返回：成功
port 整数	HTTPS 健康检查请求的 TCP 端口号。默认值为 443。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，则 HTTPS 健康检查遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
proxyHeader 字符串	指定在向后端发送数据之前要附加的代理标头的类型。返回：成功
requestPath 字符串	HTTPS 健康检查请求的请求路径。默认值为 /。返回：成功
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。返回：成功
id 整数	资源的唯一标识符。此标识符由服务器定义。返回：成功
logConfig 复杂	在此健康检查上配置日志记录。返回：成功
enable 布尔值	指示是否导出日志。默认值为 false，这意味着不会进行任何健康检查日志记录。返回：成功
name 字符串	资源的名称。由客户端在创建资源时提供。名称长度必须为 1-63 个字符，并符合 RFC1035 规范。具体来说，名称长度必须为 1-63 个字符，并匹配正则表达式 `[a-z]([-a-z0-9][a-z0-9])?`，这意味着第一个字符必须是小写字母，所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。返回：*成功
sslHealthCheck 复杂	一个嵌套的对象资源。返回：成功
port 整数	SSL 健康检查请求的 TCP 端口号。默认值为 443。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，SSL 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
proxyHeader 字符串	指定在向后端发送数据之前要附加的代理标头的类型。返回：成功
request 字符串	一旦建立 SSL 连接要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅连接建立就表示健康。请求数据只能是 ASCII。返回：成功
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。返回：成功
tcpHealthCheck 复杂	一个嵌套的对象资源。返回：成功
port 整数	TCP 健康检查请求的 TCP 端口号。默认值为 443。返回：成功
portName 字符串	InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。返回：成功
portSpecification 字符串	指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。 * `USE_NAMED_PORT`：`portName` 用于健康检查。 * `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，后端服务中指定的端口或命名端口用于健康检查。如果未指定，TCP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。返回：成功
proxyHeader 字符串	指定在向后端发送数据之前要附加的代理标头的类型。返回：成功
request 字符串	一旦建立 TCP 连接要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅连接建立就表示健康。请求数据只能是 ASCII。返回：成功
response 字符串	与响应数据开头进行匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII。返回：成功
timeoutSec 整数	在声明失败之前等待多长时间（以秒为单位）。默认值为 5 秒。timeoutSec 的值大于 checkIntervalSec 是无效的。返回：成功
type 字符串	指定 healthCheck 的类型，可以是 TCP、SSL、HTTP 或 HTTPS。如果未指定，则默认为 TCP。必须指定一个与协议相关的健康检查字段，且该字段必须与 type 字段匹配。返回：成功
unhealthyThreshold 整数	一个到目前为止健康的实例在连续失败这么多次后将被标记为不健康。默认值为 2。返回：成功

作者

Google Inc. (@googlecloudplatform)