该servicecontrol1命令行界面（CLI）允许您在终端中方便地使用Google Service Control服务的多数功能。

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

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

有关Service Control API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-servicecontrol1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版20240223的Service Control API生成的。CLI的版本是5.0.4。

servicecontrol1 [options]
        services
                allocate-quota <service-name> (-r <kv>)... [-p <v>]... [-o <out>]
                check <service-name> (-r <kv>)... [-p <v>]... [-o <out>]
                report <service-name> (-r <kv>)... [-p <v>]... [-o <out>]
  servicecontrol1 --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目录中存储所有持久数据，该目录以servicecontrol1-为前缀的JSON文件中。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

当第一次使用作用域时，会提示用户进行授权。根据CLI的指示进行授权或拒绝。

如果用户已对作用域进行认证，相关数据将以JSON格式存储在配置目录中，例如：~/.google-service-cli/servicecontrol1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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