networkconnectivity1-alpha1 命令行界面（CLI）允许您在终端中方便地使用 Google networkconnectivity 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-networkconnectivity1_alpha1-cli

在 GitHub 上查找源代码。

用法

本文档是从 networkconnectivity API 的 20240221 版本生成的。CLI 的版本为 5.0.4。

networkconnectivity1-alpha1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-delete <name> [-p <v>]... [-o <out>]
                locations-global-hubs-get <name> [-p <v>]... [-o <out>]
                locations-global-hubs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-global-hubs-list <parent> [-p <v>]... [-o <out>]
                locations-global-hubs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-hubs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-delete <name> [-p <v>]... [-o <out>]
                locations-internal-ranges-get <name> [-p <v>]... [-o <out>]
                locations-internal-ranges-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-internal-ranges-list <parent> [-p <v>]... [-o <out>]
                locations-internal-ranges-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-internal-ranges-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-spokes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-delete <name> [-p <v>]... [-o <out>]
                locations-spokes-get <name> [-p <v>]... [-o <out>]
                locations-spokes-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-spokes-list <parent> [-p <v>]... [-o <out>]
                locations-spokes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-spokes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  networkconnectivity1-alpha1 --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 文件中，以 networkconnectivity1-alpha1- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户会被要求授权。按照 CLI 提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

带有 --debug 标志将错误打印到标准错误。

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