google.cloud.gcp_compute_region_health_check_info 模块 – 收集 GCP RegionHealthCheck 的信息

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_compute_region_health_check_info。

注意

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

概要

  • 收集 GCP RegionHealthCheck 的信息

要求

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

  • python >= 2.6

  • requests >= 2.18.4

  • google-auth >= 1.3.0

参数

参数

注释

access_token

string

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

auth_kind

string / 必需

使用的凭据类型。

选择

  • "application"

  • "machineaccount"

  • "serviceaccount"

  • "accesstoken"

env_type

string

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

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

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

filters

list / elements=string

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

列表中的每个附加过滤器都将添加为 AND 条件（过滤器 1 和过滤器 2）。

project

string

要使用的 Google Cloud Platform 项目。

region

string

区域运行状况检查所在的区域。

scopes

list / elements=string

要使用的范围数组

service_account_contents

jsonarg

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

service_account_email

string

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

service_account_file

path

如果选择了 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。

  • 仅当未设置剧本值时，才会使用环境变量值。

  • service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a region health check
  gcp_compute_region_health_check_info:
    region: us-central1
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键

描述

resources

complex

资源列表

返回： 始终

checkIntervalSec

integer

发送运行状况检查的频率（以秒为单位）。默认值为 5 秒。

返回： 成功

creationTimestamp

string

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

返回： 成功

description

string

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

返回： 成功

grpcHealthCheck

complex

嵌套对象资源。

返回： 成功

grpcServiceName

string

运行状况检查的 gRPC 服务名称。

按照约定，grpcServiceName 的值具有以下含义： * 空 serviceName 表示后端所有服务的整体状态。

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

grpcServiceName 只能是 ASCII。

返回： 成功

port

integer

运行状况检查请求的端口号。

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

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

healthyThreshold

integer

一个迄今为止不健康的实例，在连续成功达到此数量后将被标记为健康。默认值为 2。

返回： 成功

http2HealthCheck

complex

嵌套对象资源。

返回： 成功

host

string

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

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

返回： 成功

port

integer

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

默认值为 443。

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

proxyHeader

string

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

返回： 成功

requestPath

string

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

默认值为 /。

返回： 成功

response

string

要与响应数据开头匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII 码。

返回： 成功

httpHealthCheck

complex

嵌套对象资源。

返回： 成功

host

string

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

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

返回： 成功

port

integer

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

默认值为 80。

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

proxyHeader

string

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

返回： 成功

requestPath

string

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

默认值为 /。

返回： 成功

response

string

要与响应数据开头匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII 码。

返回： 成功

httpsHealthCheck

complex

嵌套对象资源。

返回： 成功

host

string

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

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

返回： 成功

port

integer

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

默认值为 443。

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

proxyHeader

string

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

返回： 成功

requestPath

string

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

默认值为 /。

返回： 成功

response

string

要与响应数据开头匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII 码。

返回： 成功

id

integer

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

返回： 成功

logConfig

complex

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

返回： 成功

enable

布尔值

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

返回： 成功

name

string

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

返回： 成功

region

string

区域运行状况检查所在的区域。

返回： 成功

sslHealthCheck

complex

嵌套对象资源。

返回： 成功

port

integer

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

默认值为 443。

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

proxyHeader

string

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

返回： 成功

request

string

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

返回： 成功

response

string

要与响应数据开头匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII 码。

返回： 成功

tcpHealthCheck

complex

嵌套对象资源。

返回： 成功

port

integer

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

默认值为 80。

返回： 成功

portName

string

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

返回： 成功

portSpecification

string

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

* `USE_NAMED_PORT`：`portName` 用于运行状况检查。

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

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

返回： 成功

proxyHeader

string

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

返回： 成功

request

string

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

返回： 成功

response

string

要与响应数据开头匹配的字节。如果留空（默认值），则任何响应都将表示健康。响应数据只能是 ASCII 码。

返回： 成功

timeoutSec

integer

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

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

返回： 成功

type

string

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

返回： 成功

unhealthyThreshold

integer

一个迄今为止健康的实例，在连续失败达到此数量后将被标记为不健康。默认值为 2。

返回： 成功

作者

  • Google Inc. (@googlecloudplatform)