该storagetransfer1命令行界面（CLI）允许您在终端中舒适地使用Google storagetransfer服务的几乎所有功能。

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

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

有关storagetransfer API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo通过以下命令安装命令行界面：

cargo install google-storagetransfer1-cli

在GitHub上查找源代码。

用法

本文档是根据修订版20240224的storagetransfer API生成的。CLI版本为5.0.4。

storagetransfer1 [options]
        google-service-accounts
                get <project-id> [-p <v>]... [-o <out>]
        projects
                agent-pools-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                agent-pools-delete <name> [-p <v>]... [-o <out>]
                agent-pools-get <name> [-p <v>]... [-o <out>]
                agent-pools-list <project-id> [-p <v>]... [-o <out>]
                agent-pools-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        transfer-jobs
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <job-name> <project-id> [-p <v>]... [-o <out>]
                get <job-name> <project-id> [-p <v>]... [-o <out>]
                list <filter> [-p <v>]... [-o <out>]
                patch <job-name> (-r <kv>)... [-p <v>]... [-o <out>]
                run <job-name> (-r <kv>)... [-p <v>]... [-o <out>]
        transfer-operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> <filter> [-p <v>]... [-o <out>]
                pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
                resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
  storagetransfer1 --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文件中，这些文件以storagetransfer1-为前缀。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

有关各种类型持久数据的更多信息，请参阅以下段落。

身份验证

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

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

首次使用范围时，用户会被要求授权。根据CLI给出的说明授权或拒绝。

如果用户认证了某个范围，相应的信息将作为 JSON 存储在配置目录中，例如 ~/.google-service-cli/storagetransfer1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

--debug 标志会将错误以 Debug 表示形式打印到标准错误。

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