google.cloud.gcp_cloudtasks_queue_info 模块 – 收集 GCP 队列信息

注意

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

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

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

要在剧本中使用它，请指定：google.cloud.gcp_cloudtasks_queue_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 请求的用户代理字符串。
location 字符串 / 必需	队列的位置。
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。

• 只有在未设置剧本值时，才会使用环境变量值。

• service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a queue
  gcp_cloudtasks_queue_info:
    location: us-central1
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

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

键	描述
resources 复杂类型	资源列表 返回：始终
appEngineRoutingOverride 复杂类型	任务级 appEngineRouting 的覆盖。这些设置仅适用于此队列中的 App Engine 任务。 返回：成功
host 字符串	发送任务的主机。 返回：成功
instance 字符串	App 实例。 默认情况下，任务将发送到尝试任务时可用的实例。 返回：成功
service 字符串	App 服务。 默认情况下，任务将发送到尝试任务时为默认服务的服务。 返回：成功
version 字符串	App 版本。 默认情况下，任务将发送到尝试任务时为默认版本的版本。 返回：成功
location 字符串	队列的位置。 返回：成功
name 字符串	队列名称。 返回：成功
rateLimits 复杂类型	任务调度的速率限制。 队列的实际调度速率是以下结果：* 队列中任务的数量 * 用户指定的节流：rateLimits、retryConfig 和队列的状态。* 由于工作程序返回的 429（请求过多）或 503（服务不可用）响应、高错误率或为了平滑突然的大流量峰值而导致的系统节流。 返回：成功
maxBurstSize 整数	最大突发大小。 最大突发大小限制了当队列中有很多任务且速率很高时任务处理的速度。此字段允许队列具有高速率，以便在任务入队后不久开始处理，但在短时间内入队许多任务时仍会限制资源使用。 返回：成功
maxConcurrentDispatches 整数	Cloud Tasks 允许为此队列调度并发任务的最大数量。达到此阈值后，Cloud Tasks 会停止调度任务，直到并发请求数量减少。 返回：成功
maxDispatchesPerSecond 字符串	从此队列调度任务的最大速率。 如果在创建队列时未指定，Cloud Tasks 将选择默认值。 返回：成功
retryConfig 复杂类型	确定重试行为的设置。 返回：成功
maxAttempts 整数	每个任务的尝试次数。 Cloud Tasks 将尝试执行任务 maxAttempts 次（也就是说，如果第一次尝试失败，则将有 maxAttempts - 1 次重试）。必须 >= -1。 如果在创建队列时未指定，Cloud Tasks 将选择默认值。 -1 表示无限次尝试。 返回：成功
maxBackoff 字符串	如果队列的 RetryConfig 指定应重试任务，则任务将在失败后 minBackoff 和 maxBackoff 之间的持续时间内安排重试。 返回：成功
maxDoublings 整数	重试之间的时间将翻倍 maxDoublings 次。 任务的重试间隔从 minBackoff 开始，然后翻倍 maxDoublings 次，然后线性增加，最后以 maxBackoff 的间隔重试，最多重试 maxAttempts 次。 返回：成功
maxRetryDuration 字符串	如果为正数，`maxRetryDuration` 指定失败任务重试的时间限制，从首次尝试任务时开始计时。一旦超过 `maxRetryDuration` 时间并且任务已尝试 `maxAttempts` 次，则不会再进行任何尝试，并且任务将被删除。 如果为零，则任务年龄不受限制。 返回：成功
minBackoff 字符串	如果队列的 RetryConfig 指定应重试任务，则任务将在失败后 minBackoff 和 maxBackoff 之间的持续时间内安排重试。 返回：成功
purgeTime 字符串	上次清除此队列的时间。 返回：成功
stackdriverLoggingConfig 复杂类型	写入 Stackdriver Logging 的日志配置选项。 返回：成功
samplingRatio 字符串	指定写入 Stackdriver Logging 的操作比例。 此字段可以包含 0.0 到 1.0（包含）之间的任何值。0.0 是默认值，表示不记录任何操作。 返回：成功
status 字符串	队列的当前状态。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

相关链接

• 问题追踪器
• 主页
• 代码仓库