#cli #google #google-api #replicapoolupdater

应用 google-replicapoolupdater1_beta1-cli

一个用于与replicapoolupdater(协议v1beta1)交互的完整库

19个稳定版本 (4个主要版本)

5.0.4+20161003 2024年3月5日
3.0.0+20161003 2022年3月8日
2.0.4+20161003 2021年4月15日
1.0.14+20161003 2020年7月10日
0.3.6+20160229 2016年9月11日

网络编程中排名第1995位

Download history 13/week @ 2024-03-10 1/week @ 2024-03-17 167/week @ 2024-03-31 2/week @ 2024-04-07 1/week @ 2024-05-19

每月下载量达414次

MIT许可证

290KB
4K SLoC

replicapoolupdater1-beta1命令行界面(CLI)允许您在终端中舒适地使用Google replicapoolupdater服务的多数功能。

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

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

有关replicapoolupdater API的详细信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-replicapoolupdater1_beta1-cli

GitHub上找到源代码。

用法

本文档是从修订版20161003replicapoolupdater API生成的。CLI的版本为5.0.4

replicapoolupdater1-beta1 [options]
        rolling-updates
                cancel <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
                get <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
                insert <project> <zone> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> <zone> [-p <v>]... [-o <out>]
                list-instance-updates <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
                pause <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
                resume <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
                rollback <project> <zone> <rolling-update> [-p <v>]... [-o <out>]
        zone-operations
                get <project> <zone> <operation> [-p <v>]... [-o <out>]
                list <project> <zone> [-p <v>]... [-o <out>]
  replicapoolupdater1-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目录中存储所有持久数据,其中以replicapoolupdater1-beta1-为前缀的JSON文件。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,用户会被要求授权。按照CLI给出的说明授权或拒绝。

如果用户认证了范围,相关信息将以JSON格式存储在配置目录中,例如~/.google-service-cli/replicapoolupdater1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~19–31MB
~578K SLoC