domains1 命令行接口（CLI）允许您在终端中舒适地使用Google Cloud Domains服务的多数功能。

默认情况下，所有输出都会打印到标准输出，但可以设置标志将其直接发送到文件，而不依赖于shell的功能。错误将打印到标准错误，并导致程序退出代码不为零。

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

有关云域API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行接口：

cargo install google-domains1-cli

在GitHub上查找源代码。

用法

此文档是从修订版20240221的Cloud Domains API生成的。CLI版本为5.0.4。

domains1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-registrations-configure-contact-settings <registration> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-configure-dns-settings <registration> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-configure-management-settings <registration> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-delete <name> [-p <v>]... [-o <out>]
                locations-registrations-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-get <name> [-p <v>]... [-o <out>]
                locations-registrations-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-registrations-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-list <parent> [-p <v>]... [-o <out>]
                locations-registrations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-register <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-reset-authorization-code <registration> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-retrieve-authorization-code <registration> [-p <v>]... [-o <out>]
                locations-registrations-retrieve-importable-domains <location> [-p <v>]... [-o <out>]
                locations-registrations-retrieve-register-parameters <location> [-p <v>]... [-o <out>]
                locations-registrations-retrieve-transfer-parameters <location> [-p <v>]... [-o <out>]
                locations-registrations-search-domains <location> [-p <v>]... [-o <out>]
                locations-registrations-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registrations-transfer <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  domains1 --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文件中，文件名以domains1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，用户将被要求授予权限。遵循CLI给出的说明授予权限或拒绝。

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

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

应用程序密钥

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

为了使CLI的使用更加方便，而不必强迫任何人注册自己的应用程序，CLI自带了一个默认应用程序密钥，并据此进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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

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