该 cloudfunctions1 命令行界面 (CLI) 允许您在终端中方便地使用Google Cloud Functions服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudfunctions1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20240229 的云函数API生成的。CLI版本为 5.0.4。

cloudfunctions1 [options]
        operations
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        projects
                locations-functions-call <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-create <location> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-delete <name> [-p <v>]... [-o <out>]
                locations-functions-generate-download-url <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-generate-upload-url <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-get <name> [-p <v>]... [-o <out>]
                locations-functions-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-functions-list <parent> [-p <v>]... [-o <out>]
                locations-functions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-functions-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
  cloudfunctions1 --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 文件中，文件以 cloudfunctions1- 开头。您可以使用 --config-dir 标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，会询问用户权限。按照 CLI 的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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