policytroubleshooter1 命令行界面（CLI）允许您在终端中舒适地使用 Google 策略故障排除器服务的大多数功能。

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

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

有关策略故障排除器 API 的其他所有信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-policytroubleshooter1-cli

在 GitHub 上查找源代码。

用法

此文档是根据修订版 20240303 的 策略故障排除器 API 生成的。CLI 版本为 5.0.4。

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

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

身份验证

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

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

首次使用范围时，系统会请求用户授权。按照CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

为了使CLI的用法更舒适，而无需强迫任何人注册自己的应用程序，CLI自带了一个默认的应用程序密钥，并进行相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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