6个稳定版本

5.0.4+20240221 2024年3月5日
3.1.0+20220128 2022年4月26日
3.0.0+20220128 2022年3月8日
2.0.4+20210216 2021年4月15日

2420Web编程

Download history 4/week @ 2024-05-21

108 每月下载量

MIT 许可证

790KB
9K SLoC

domains1-beta1 命令行界面(CLI)允许您从终端舒适地使用Google Cloud Domains服务的大部分功能。

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

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

有关云域API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo通过以下命令安装命令行界面:

cargo install google-domains1_beta1-cli

GitHub上查找源代码。

用法

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

domains1-beta1 [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-beta1 --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 目录中存储所有持久数据,该目录以 domains1-beta1- 开头的前缀的 JSON 文件。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,系统会要求用户授权。根据CLI的说明授予权限或拒绝。

如果某个作用域已被用户认证,相关信息均将存储在配置目录中的JSON格式中,例如:~/.google-service-cli/domains1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

要撤销已授权的认证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

--debug标志将以Debug表示形式将错误打印到标准错误。

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

依赖项

~20–31MB
~577K SLoC