该cloudtasks2-beta2命令行界面（CLI）允许您从终端舒适地使用Google Cloud Tasks服务的大部分功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而不依赖于shell的功能。错误将打印到标准错误，并导致程序退出码非零。

如果请求数据结构，则这些结构将作为格式化良好的JSON返回，以便作为其他工具的输入。

有关Cloud Tasks API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudtasks2_beta2-cli

在GitHub上找到源代码。

用法

本文档是根据修订版20240223的Cloud Tasks API生成的。CLI的版本为5.0.4。

cloudtasks2-beta2 [options]
        api
                queue-update (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-cmek-config <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-queues-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-delete <name> [-p <v>]... [-o <out>]
                locations-queues-get <name> [-p <v>]... [-o <out>]
                locations-queues-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-list <parent> [-p <v>]... [-o <out>]
                locations-queues-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-purge <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-acknowledge <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-buffer <queue> <task-id> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-cancel-lease <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-delete <name> [-p <v>]... [-o <out>]
                locations-queues-tasks-get <name> [-p <v>]... [-o <out>]
                locations-queues-tasks-lease <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-list <parent> [-p <v>]... [-o <out>]
                locations-queues-tasks-renew-lease <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-tasks-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-queues-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-update-cmek-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudtasks2-beta2 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将在~/.google-service-cli目录中存储所有持久数据，该目录以cloudtasks2-beta2-为前缀的JSON文件开始。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种持久数据的更多信息。

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这种情况，则作用域确定授予的权限集。这些通常不超过只读或完全访问。

如果没有设置，则系统将自动选择最小的可行作用域，例如，当调用只读方法时，它将仅请求只读作用域。您可以使用--scope标志直接指定作用域。所有适用的作用域均在相应方法的CLI文档中进行了记录。

当第一次使用作用域时，会要求用户授权。按照CLI提供的说明进行授权或拒绝。

如果用户已认证作用域，相关信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/cloudtasks2-beta2-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销授权，请参考官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，需要使用Google开发者控制台进行注册。应用程序可能使用的API会逐一启用。大多数API可以免费使用，并且有每日配额。

为了使CLI的使用更加方便，而无需强制任何人注册自己的应用程序，CLI自带一个默认的应用程序密钥，并进行相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您的密钥文件放在此位置来解决这个问题：~/.google-service-cli/cloudtasks2-beta2-secret.json，假设已为它启用了所需的cloudtasks API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI已尽力提供可用的错误消息，但有时了解导致特定问题的确切原因可能更有帮助。这是通过允许将所有客户端-服务器通信输出到标准错误原样输出来实现的。

使用--debug标志将使用Debug表示法将错误打印到标准错误。

您可以考虑将标准错误重定向到文件以便于使用，例如：cloudtasks2-beta2 --debug <resource> <method> [options] 2>debug.txt。