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

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其重定向到文件，而不管您的 shell 功能如何。错误将打印到标准错误，并导致程序退出代码非零。

如果请求数据结构，则这些结构将以漂亮的打印 JSON 返回，可作为其他工具的输入使用。

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-servicebroker1-cli

在 github 上找到源代码。

用法

本文档是从修订版 20190624 的 Service Broker API 生成的。CLI 版本为 5.0.4。

servicebroker1 [options]
        methods
                get-iam-policy <resource> [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  servicebroker1 --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 目录中存储所有持久数据，目录中的 servicebroker1- 前缀文件是 JSON 文件。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，会询问用户权限。根据 CLI 的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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