google.cloud.gcp_compute_http_health_check_info 模块 – 收集 GCP HttpHealthCheck 的信息

注意

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

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

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

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

注意

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

概要 

收集 GCP HttpHealthCheck 的信息

要求 

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

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 项目。
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 HTTP health check
  gcp_compute_http_health_check_info:
    filters:
    - name = test_object
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值 

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

键	描述
resources 复杂	资源列表返回：始终
checkIntervalSec integer	发送运行状况检查的频率（以秒为单位）。默认值为 5 秒。返回：成功
creationTimestamp string	RFC3339 文本格式的创建时间戳。返回：成功
description string	此资源的可选描述。创建资源时提供此属性。返回：成功
healthyThreshold integer	在连续成功这么多次后，至今不健康的实例将被标记为健康。默认值为 2。返回：成功
host string	HTTP 运行状况检查请求中主机标头的值。如果留空（默认值），将使用代表此运行状况检查执行的公共 IP。返回：成功
id integer	资源的唯一标识符。此标识符由服务器定义。返回：成功
name string	资源的名称。由客户端在创建资源时提供。该名称的长度必须为 1-63 个字符，并符合 RFC1035。具体来说，该名称的长度必须为 1-63 个字符，并与正则表达式 `[a-z]([-a-z0-9][a-z0-9])?` 匹配，这意味着第一个字符必须是小写字母，并且所有后续字符必须是短划线、小写字母或数字，但最后一个字符不能是短划线。返回：* 成功
port integer	HTTP 运行状况检查请求的 TCP 端口号。默认值为 80。返回：成功
requestPath string	HTTP 运行状况检查请求的请求路径。默认值为 /。返回：成功
timeoutSec integer	在声明失败之前等待的时间（以秒为单位）。默认值为 5 秒。timeoutSec 的值大于 checkIntervalSec 是无效的。返回：成功
unhealthyThreshold integer	在连续失败这么多次后，至今健康的实例将被标记为不健康。默认值为 2。返回：成功

作者

Google Inc. (@googlecloudplatform)