google.cloud.gcp_cloudscheduler_job_info 模块 – 收集 GCP 作业信息

注意

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

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

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

要在 playbook 中使用它，请指定：google.cloud.gcp_cloudscheduler_job_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 字符串。
project 字符串	要使用的 Google Cloud Platform 项目。
region 字符串 / 必需	计划程序作业所在的区域。
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 job
  gcp_cloudscheduler_job_info:
    region: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键	描述
资源 复杂	资源列表 返回：始终
appEngineHttpTarget 复杂	App Engine HTTP 目标。 如果作业提供 App Engine HTTP 目标，则 cron 将向服务实例发送请求。 返回：成功
appEngineRouting 复杂	作业的 App Engine 路由设置。 返回：成功
instance 字符串	App 实例。 默认情况下，作业会发送到在尝试作业时可用的实例。 返回：成功
service 字符串	App 服务。 默认情况下，作业会发送到尝试作业时的默认服务。 返回：成功
version 字符串	App 版本。 默认情况下，作业会发送到尝试作业时的默认版本。 返回：成功
body 字符串	HTTP 请求正文。仅当 HTTP 方法为 POST 或 PUT 时才允许使用请求正文。在不兼容的 HttpMethod 的作业上设置正文会导致无效参数错误。 base64 编码的字符串。 返回：成功
headers 字典	HTTP 请求标头。 此映射包含标头字段名称和值。可以在创建作业时设置标头。 返回：成功
httpMethod 字符串	要用于请求的 HTTP 方法。 返回：成功
relativeUri 字符串	相对 URI。 返回：成功
attemptDeadline 字符串	作业尝试的截止时间。如果请求处理程序在此截止时间之前没有响应，则请求将被取消，并且该尝试将被标记为 DEADLINE_EXCEEDED 失败。可以在执行日志中查看失败的尝试。Cloud Scheduler 将根据 RetryConfig 重试作业。 此截止时间的允许持续时间为：* 对于 HTTP 目标，介于 15 秒到 30 分钟之间。 * 对于 App Engine HTTP 目标，介于 15 秒到 24 小时之间。 * **注意**：对于 PubSub 目标，此字段将被忽略 - 设置它会引入无法解决的差异。 以秒为单位的持续时间，最多包含九位小数位，并以“s”结尾。示例：“3.5s”。 返回：成功
description 字符串	作业的人工可读描述。此字符串不能超过 500 个字符。 返回：成功
httpTarget 复杂	HTTP 目标。 如果作业提供 http_target，则 cron 将向目标 URL 发送请求。 返回：成功
body 字符串	HTTP 请求正文。仅当 HTTP 方法为 POST、PUT 或 PATCH 时才允许使用请求正文。在不兼容的 HttpMethod 的作业上设置正文会导致错误。 base64 编码的字符串。 返回：成功
headers 字典	此映射包含标头字段名称和值。不支持重复标头，但是标头值可以包含逗号。 返回：成功
httpMethod 字符串	要用于请求的 HTTP 方法。 返回：成功
oauthToken 复杂	包含生成 OAuth 令牌所需的信息。 在向 GCP 端点发送请求时应使用此类型的授权。 返回：成功
scope 字符串	用于生成 OAuth 访问令牌的 OAuth 作用域。如果未指定，则将使用“https://www.googleapis.com/auth/cloud-platform”。 返回：成功
serviceAccountEmail 字符串	用于生成 OAuth 令牌的服务帐户电子邮件。 服务帐户必须与作业位于同一项目中。 返回：成功
oidcToken 复杂	包含生成 OpenID Connect 令牌所需的信息。 当向第三方端点或 Cloud Run 发送请求时，应使用此类型的授权。 返回：成功
audience 字符串	生成 OIDC 令牌时要使用的受众。如果未指定，则将使用目标中指定的 URI。 返回：成功
serviceAccountEmail 字符串	用于生成 OAuth 令牌的服务帐户电子邮件。 服务帐户必须与作业位于同一项目中。 返回：成功
uri 字符串	请求将发送到的完整 URI 路径。 返回：成功
name 字符串	作业的名称。 返回：成功
pubsubTarget 复杂	Pub/Sub 目标。如果作业提供 Pub/Sub 目标，则 cron 将向提供的主题发布消息。 返回：成功
attributes 字典	PubsubMessage 的属性。 Pubsub 消息必须包含非空数据，或至少包含一个属性。 返回：成功
data 字符串	PubsubMessage 的消息有效负载。 Pubsub 消息必须包含非空数据，或至少包含一个属性。 base64 编码的字符串。 返回：成功
topicName 字符串	当作业交付时，将向其发布消息的 Cloud Pub/Sub 主题的完整资源名称。 ~>**注意：** 主题名称的格式必须与 PubSub 的 PublishRequest.name 所要求的格式相同，例如 `projects/my-project/topics/my-topic`。 返回：成功
region 字符串	计划程序作业所在的区域。 返回：成功
retryConfig 复杂	默认情况下，如果作业未成功完成，即未收到处理程序的确认，则将根据设置以指数退避方式重试。 返回：成功
maxBackoffDuration 字符串	在作业失败后重试之前等待的最大时间量。 一个以秒为单位的持续时间，最多可包含九个小数位，并以“s”结尾。 返回：成功
maxDoublings 整数	重试之间的时间将翻倍 maxDoublings 次。 作业的重试间隔从 minBackoffDuration 开始，然后翻倍 maxDoublings 次，然后线性增加，最后以 maxBackoffDuration 的间隔重试，最多重试 retryCount 次。 返回：成功
maxRetryDuration 字符串	重试失败作业的时间限制，从首次尝试执行的时间开始计算。如果与 retryCount 一起指定，则将重试作业，直到达到两个限制。 一个以秒为单位的持续时间，最多可包含九个小数位，并以“s”结尾。 返回：成功
minBackoffDuration 字符串	在作业失败后重试之前等待的最短时间量。 一个以秒为单位的持续时间，最多可包含九个小数位，并以“s”结尾。 返回：成功
retryCount 整数	系统将使用 maxDoublings 描述的指数退避过程运行作业的尝试次数。 不允许大于 5 的值和负值。 返回：成功
schedule 字符串	描述作业将执行的计划。 返回：成功
timeZone 字符串	指定在解释计划时要使用的时区。 此字段的值必须是 tz 数据库中的时区名称。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）