google.cloud.gcp_compute_health_check_info 模块 – 收集 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_info。

注意

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

概要

  • 收集 GCP 健康检查的信息

要求

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

  • 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

列表 / 元素=字符串

筛选值对的列表。此处列出了可用的筛选器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 health check
  gcp_compute_health_check_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

资源

复杂

资源列表

已返回： 始终

checkIntervalSec

整数

发送健康检查的频率（以秒为单位）。默认值为 5 秒。

已返回： 成功

creationTimestamp

字符串

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

已返回： 成功

description

字符串

此资源的可选描述。创建资源时提供此属性。

已返回： 成功

grpcHealthCheck

复杂

嵌套对象资源。

已返回： 成功

grpcServiceName

字符串

gRPC 健康检查的服务名称。

按照惯例，grpcServiceName 的值具有以下含义：- 空的 serviceName 表示后端所有服务的总体状态。

  • 非空的 serviceName 表示该 gRPC 服务的运行状况，由服务的所有者定义。

grpcServiceName 只能是 ASCII 字符。

已返回： 成功

端口

整数

用于健康检查请求的端口号。

如果未设置 portName 和 portSpecification，或 port_specification 为 USE_FIXED_PORT，则必须指定此项。有效值为 1 到 65535。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，gRPC 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

健康阈值

整数

一个之前不健康的实例在连续成功达到此次数后将被标记为健康。默认值为 2。

已返回： 成功

http2 健康检查

复杂

嵌套对象资源。

已返回： 成功

主机

字符串

HTTP2 健康检查请求中主机头的值。

如果为空（默认值），将使用执行此健康检查的公共 IP。

已返回： 成功

端口

整数

用于 HTTP2 健康检查请求的 TCP 端口号。

默认值为 443。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，HTTP2 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

代理标头

字符串

指定在将数据发送到后端之前要附加的代理标头类型。

已返回： 成功

请求路径

字符串

HTTP2 健康检查请求的请求路径。

默认值为 /。

已返回： 成功

响应

字符串

要与响应数据开头进行匹配的字节。如果为空（默认值），任何响应都将指示健康。响应数据只能是 ASCII 字符。

已返回： 成功

http 健康检查

复杂

嵌套对象资源。

已返回： 成功

主机

字符串

HTTP 健康检查请求中主机头的值。

如果为空（默认值），将使用执行此健康检查的公共 IP。

已返回： 成功

端口

整数

用于 HTTP 健康检查请求的 TCP 端口号。

默认值为 80。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，HTTP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

代理标头

字符串

指定在将数据发送到后端之前要附加的代理标头类型。

已返回： 成功

请求路径

字符串

HTTP 健康检查请求的请求路径。

默认值为 /。

已返回： 成功

响应

字符串

要与响应数据开头进行匹配的字节。如果为空（默认值），任何响应都将指示健康。响应数据只能是 ASCII 字符。

已返回： 成功

https 健康检查

复杂

嵌套对象资源。

已返回： 成功

主机

字符串

HTTPS 健康检查请求中主机头的值。

如果为空（默认值），将使用执行此健康检查的公共 IP。

已返回： 成功

端口

整数

用于 HTTPS 健康检查请求的 TCP 端口号。

默认值为 443。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，HTTPS 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

代理标头

字符串

指定在将数据发送到后端之前要附加的代理标头类型。

已返回： 成功

请求路径

字符串

HTTPS 健康检查请求的请求路径。

默认值为 /。

已返回： 成功

响应

字符串

要与响应数据开头进行匹配的字节。如果为空（默认值），任何响应都将指示健康。响应数据只能是 ASCII 字符。

已返回： 成功

ID

整数

资源的唯一标识符。此标识符由服务器定义。

已返回： 成功

日志配置

复杂

配置此健康检查的日志记录。

已返回： 成功

启用

布尔值

指示是否导出日志。默认值为 false，这意味着不会进行健康检查日志记录。

已返回： 成功

名称

字符串

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

已返回： 成功

ssl 健康检查

复杂

嵌套对象资源。

已返回： 成功

端口

整数

用于 SSL 健康检查请求的 TCP 端口号。

默认值为 443。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，SSL 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

代理标头

字符串

指定在将数据发送到后端之前要附加的代理标头类型。

已返回： 成功

请求

字符串

在建立 SSL 连接后要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅建立连接将指示健康。请求数据只能是 ASCII 字符。

已返回： 成功

响应

字符串

要与响应数据开头进行匹配的字节。如果为空（默认值），任何响应都将指示健康。响应数据只能是 ASCII 字符。

已返回： 成功

tcp 健康检查

复杂

嵌套对象资源。

已返回： 成功

端口

整数

用于 TCP 健康检查请求的 TCP 端口号。

默认值为 443。

已返回： 成功

端口名称

字符串

在 InstanceGroup#NamedPort#name 中定义的端口名称。如果同时定义了 port 和 port_name，则 port 优先。

已返回： 成功

端口规范

字符串

指定如何为健康检查选择端口，可以是以下值之一：* `USE_FIXED_PORT`：`port` 中的端口号用于健康检查。

* `USE_NAMED_PORT`：`portName` 用于健康检查。

* `USE_SERVING_PORT`：对于 NetworkEndpointGroup，每个网络端点指定的端口用于健康检查。对于其他后端，Backend Service 中指定的端口或命名端口用于健康检查。

如果未指定，TCP 健康检查将遵循 `port` 和 `portName` 字段中指定的行为。

已返回： 成功

代理标头

字符串

指定在将数据发送到后端之前要附加的代理标头类型。

已返回： 成功

请求

字符串

在建立 TCP 连接后要发送的应用程序数据（默认值为空）。如果请求和响应都为空，则仅建立连接将指示健康。请求数据只能是 ASCII 字符。

已返回： 成功

响应

字符串

要与响应数据开头进行匹配的字节。如果为空（默认值），任何响应都将指示健康。响应数据只能是 ASCII 字符。

已返回： 成功

超时秒数

整数

在声明失败之前等待多长时间（以秒为单位）。

默认值为 5 秒。timeoutSec 的值不能大于 checkIntervalSec。

已返回： 成功

类型

字符串

指定 healthCheck 的类型，可以是 TCP、SSL、HTTP 或 HTTPS。如果未指定，则默认为 TCP。必须指定一个与类型字段匹配的特定于协议的健康检查字段。

已返回： 成功

不健康阈值

整数

一个之前健康的实例在连续失败达到此次数后将被标记为不健康。默认值为 2。

已返回： 成功

作者

  • Google Inc. (@googlecloudplatform)