dns2 命令行界面 (CLI) 允许您从终端舒适地使用 Google Dns 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-dns2-cli

在 GitHub 上查找源代码。

用法

本文档是根据 Dns API 修订版 20240229 生成的。CLI 版本为 5.0.4。

dns2 [options]
        changes
                create <project> <location> <managed-zone> (-r <kv>)... [-p <v>]... [-o <out>]
                get <project> <location> <managed-zone> <change-id> [-p <v>]... [-o <out>]
                list <project> <location> <managed-zone> [-p <v>]... [-o <out>]
        dns-keys
                get <project> <location> <managed-zone> <dns-key-id> [-p <v>]... [-o <out>]
                list <project> <location> <managed-zone> [-p <v>]... [-o <out>]
        managed-zone-operations
                get <project> <location> <managed-zone> <operation> [-p <v>]... [-o <out>]
                list <project> <location> <managed-zone> [-p <v>]... [-o <out>]
        managed-zones
                create <project> <location> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <location> <managed-zone> [-p <v>]...
                get <project> <location> <managed-zone> [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <location> [-p <v>]... [-o <out>]
                patch <project> <location> <managed-zone> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <location> <managed-zone> (-r <kv>)... [-p <v>]... [-o <out>]
        policies
                create <project> <location> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <location> <policy> [-p <v>]...
                get <project> <location> <policy> [-p <v>]... [-o <out>]
                list <project> <location> [-p <v>]... [-o <out>]
                patch <project> <location> <policy> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <location> <policy> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                get <project> <location> [-p <v>]... [-o <out>]
        resource-record-sets
                create <project> <location> <managed-zone> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <location> <managed-zone> <name> <type> [-p <v>]...
                get <project> <location> <managed-zone> <name> <type> [-p <v>]... [-o <out>]
                list <project> <location> <managed-zone> [-p <v>]... [-o <out>]
                patch <project> <location> <managed-zone> <name> <type> (-r <kv>)... [-p <v>]... [-o <out>]
        response-policies
                create <project> <location> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <location> <response-policy> [-p <v>]...
                get <project> <location> <response-policy> [-p <v>]... [-o <out>]
                list <project> <location> [-p <v>]... [-o <out>]
                patch <project> <location> <response-policy> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <location> <response-policy> (-r <kv>)... [-p <v>]... [-o <out>]
        response-policy-rules
                create <project> <location> <response-policy> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project> <location> <response-policy> <response-policy-rule> [-p <v>]...
                get <project> <location> <response-policy> <response-policy-rule> [-p <v>]... [-o <out>]
                list <project> <location> <response-policy> [-p <v>]... [-o <out>]
                patch <project> <location> <response-policy> <response-policy-rule> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project> <location> <response-policy> <response-policy-rule> (-r <kv>)... [-p <v>]... [-o <out>]
  dns2 --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 文件中，文件名以 dns2- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会请求权限。遵循 CLI 提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以方便使用，例如dns2 --debug <资源> <方法> [选项] 2>debug.txt。