通过命令行界面（CLI）使用 Google Cloud Composer 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其重定向到文件，而无需考虑您的 shell 能力。错误将打印到标准错误，并导致程序的退出码不为零。

如果请求数据结构，这些结构将以美观打印的 JSON 格式返回，以便作为其他工具的输入。

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-composer1-cli

在 GitHub 上查找源代码。

用法

本文档是从 Cloud Composer API 的修订版 20240227 生成的。CLI 的版本是 5.0.4。

composer1 [options]
        projects
                locations-environments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-database-failover <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-delete <name> [-p <v>]... [-o <out>]
                locations-environments-execute-airflow-command <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-fetch-database-properties <environment> [-p <v>]... [-o <out>]
                locations-environments-get <name> [-p <v>]... [-o <out>]
                locations-environments-list <parent> [-p <v>]... [-o <out>]
                locations-environments-load-snapshot <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-poll-airflow-command <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-save-snapshot <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-stop-airflow-command <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-user-workloads-config-maps-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-user-workloads-config-maps-delete <name> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-config-maps-get <name> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-config-maps-list <parent> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-config-maps-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-user-workloads-secrets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-user-workloads-secrets-delete <name> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-secrets-get <name> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-secrets-list <parent> [-p <v>]... [-o <out>]
                locations-environments-user-workloads-secrets-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-workloads-list <parent> [-p <v>]... [-o <out>]
                locations-image-versions-list <parent> [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
  composer1 --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 目录中的 JSON 文件中，文件名以 composer1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

如果未设置，系统将自动选择最小的可行范围，例如，当调用只读方法时，它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围都在各自方法的 CLI 文档中有记录。

第一次使用范围时，会要求用户授权。按照 CLI 给出的说明授权或拒绝授权。

如果作用域已被用户验证，则相应信息将作为JSON存储在配置目录中，例如~/.google-service-cli/composer1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的验证，请参阅官方文档。

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误消息，但有时可能希望知道导致特定问题确切原因。这是通过允许将所有客户端-服务器通信直接输出到标准错误（原样输出）来完成的。

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

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