该cloudlatencytest2命令行界面(CLI)允许您在终端中方便地使用Google cloudlatencytest服务的几乎所有功能。

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudlatencytest2-cli

在GitHub上找到源代码。

用法

本文档是从cloudlatencytest API的修订版20160309生成的。CLI版本为5.0.4。

cloudlatencytest2 [options]
        statscollection
                updateaggregatedstats (-r <kv>)... [-p <v>]... [-o <out>]
                updatestats (-r <kv>)... [-p <v>]... [-o <out>]
  cloudlatencytest2 --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文件中，文件名以cloudlatencytest2-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

当第一次使用作用域时，会请求用户授权。按照CLI给出的指示进行授权或拒绝。

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

要撤销授权，请参考官方文档。

应用程序密钥

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

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

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

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

调试

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

使用--debug标志会将错误以Debug表示形式输出到标准错误。

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