该 prod-tt-sasportal1-alpha1 命令行界面 (CLI) 允许您从终端舒适地使用 Google SAS Portal 测试服务的几乎所有功能。

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

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

有关 SAS Portal 测试 API 的所有其他信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-prod_tt_sasportal1_alpha1-cli

在 GitHub 上找到源代码。

用法

本文档是根据 SAS Portal 测试 API 在 20240226 版本中生成的。CLI 的版本为 5.0.4。

prod-tt-sasportal1-alpha1 [options]
        customers
                deployments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-delete <name> [-p <v>]... [-o <out>]
                deployments-devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-devices-list <parent> [-p <v>]... [-o <out>]
                deployments-get <name> [-p <v>]... [-o <out>]
                deployments-list <parent> [-p <v>]... [-o <out>]
                deployments-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-delete <name> [-p <v>]... [-o <out>]
                devices-get <name> [-p <v>]... [-o <out>]
                devices-list <parent> [-p <v>]... [-o <out>]
                devices-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-sign-device <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-update-signed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                list-gcp-project-deployments [-p <v>]... [-o <out>]
                list-legacy-organizations [-p <v>]... [-o <out>]
                migrate-organization (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-delete <name> [-p <v>]... [-o <out>]
                nodes-deployments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-deployments-list <parent> [-p <v>]... [-o <out>]
                nodes-devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-devices-list <parent> [-p <v>]... [-o <out>]
                nodes-get <name> [-p <v>]... [-o <out>]
                nodes-list <parent> [-p <v>]... [-o <out>]
                nodes-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-nodes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-nodes-list <parent> [-p <v>]... [-o <out>]
                nodes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                provision-deployment (-r <kv>)... [-p <v>]... [-o <out>]
                setup-sas-analytics (-r <kv>)... [-p <v>]... [-o <out>]
        deployments
                devices-delete <name> [-p <v>]... [-o <out>]
                devices-get <name> [-p <v>]... [-o <out>]
                devices-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-sign-device <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-update-signed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
        installer
                generate-secret (-r <kv>)... [-p <v>]... [-o <out>]
                validate (-r <kv>)... [-p <v>]... [-o <out>]
        nodes
                deployments-delete <name> [-p <v>]... [-o <out>]
                deployments-devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-devices-list <parent> [-p <v>]... [-o <out>]
                deployments-get <name> [-p <v>]... [-o <out>]
                deployments-list <parent> [-p <v>]... [-o <out>]
                deployments-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                deployments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-delete <name> [-p <v>]... [-o <out>]
                devices-get <name> [-p <v>]... [-o <out>]
                devices-list <parent> [-p <v>]... [-o <out>]
                devices-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-sign-device <name> (-r <kv>)... [-p <v>]... [-o <out>]
                devices-update-signed <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                nodes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-delete <name> [-p <v>]... [-o <out>]
                nodes-deployments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-deployments-list <parent> [-p <v>]... [-o <out>]
                nodes-devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-devices-create-signed <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-devices-list <parent> [-p <v>]... [-o <out>]
                nodes-get <name> [-p <v>]... [-o <out>]
                nodes-list <parent> [-p <v>]... [-o <out>]
                nodes-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-nodes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                nodes-nodes-list <parent> [-p <v>]... [-o <out>]
                nodes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        policies
                get (-r <kv>)... [-p <v>]... [-o <out>]
                set (-r <kv>)... [-p <v>]... [-o <out>]
                test (-r <kv>)... [-p <v>]... [-o <out>]
  prod-tt-sasportal1-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 文件中，文件名以 prod-tt-sasportal1-alpha1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户会被要求授权。按照CLI的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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