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。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定：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。
仅当未设置 playbook 值时，才会使用环境变量值。
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 和 1.0）的任何值。0.0 是默认值，表示不记录任何操作。返回：成功
status 字符串	队列的当前状态。返回：成功

作者

Google Inc. (@googlecloudplatform)