#google-cloud #google #cli #google-api #cloudscheduler #command-line-interface

app google-cloudscheduler1_beta1-cli

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

9个稳定版本 (3个主要版本)

5.0.4+20240226 2024年3月5日
3.1.0+20220212 2022年4月26日
2.0.4+20210315 2021年4月14日
1.0.14+20200618 2020年7月10日
1.0.10+20190617 2019年7月6日

#2739 in Web编程

Download history 1/week @ 2024-05-21 15/week @ 2024-07-02

每月177次下载

MIT 许可证

310KB
4K SLoC

cloudscheduler1-beta1命令行界面(CLI)允许您从终端舒适地使用Google Cloud Scheduler服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-cloudscheduler1_beta1-cli

GitHub上找到源代码。

用法

本文档是根据修订版20240226Cloud Scheduler API生成的。CLI版本为5.0.4

cloudscheduler1-beta1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-delete <name> [-p <v>]... [-o <out>]
                locations-jobs-get <name> [-p <v>]... [-o <out>]
                locations-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
  cloudscheduler1-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目录中的JSON文件中,文件名以cloudscheduler1-beta1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,会要求用户授权。按照CLI给出的指示授予权限或拒绝。

如果用户已对范围进行身份验证,相关信息将作为JSON存储在配置目录中,例如~/.google-service-cli/cloudscheduler1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC