ids1 命令行界面（CLI）允许您在终端中舒适地使用 Google IDS 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-ids1-cli

在 github 上找到源代码。

用法

此文档是从修订版 20231203 的 IDS API 生成的。CLI 的版本是 5.0.4。

ids1 [options]
        projects
                locations-endpoints-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-endpoints-delete <name> [-p <v>]... [-o <out>]
                locations-endpoints-get <name> [-p <v>]... [-o <out>]
                locations-endpoints-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-endpoints-list <parent> [-p <v>]... [-o <out>]
                locations-endpoints-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-endpoints-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-endpoints-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-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>]
  ids1 --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 文件中，文件名以 ids1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照 CLI 提供的说明授权权限或拒绝授权。

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

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

应用程序密钥

为了让任何应用程序使用Google服务，它需要通过Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用，并有限额。

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

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

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

调试

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

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

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