4个稳定版本

5.0.4+20240303 2024年3月5日
3.1.0+20220303 2022年4月26日
2.0.4+20210326 2021年4月15日
2.0.0+20210326 2021年4月2日

#2937网络编程

Download history 2/week @ 2024-04-07

每月67次下载

MIT 许可证

1.5MB
19K SLoC

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

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

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

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

安装和源代码

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

cargo install google-cloudchannel1-cli

github上找到源代码。

使用方法

此文档是从修订版20240303的Cloudchannel API生成的。CLI版本为5.0.4

cloudchannel1 [options]
        accounts
                channel-partner-links-channel-partner-repricing-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-channel-partner-repricing-configs-delete <name> [-p <v>]... [-o <out>]
                channel-partner-links-channel-partner-repricing-configs-get <name> [-p <v>]... [-o <out>]
                channel-partner-links-channel-partner-repricing-configs-list <parent> [-p <v>]... [-o <out>]
                channel-partner-links-channel-partner-repricing-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-customers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-customers-delete <name> [-p <v>]... [-o <out>]
                channel-partner-links-customers-get <name> [-p <v>]... [-o <out>]
                channel-partner-links-customers-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-customers-list <parent> [-p <v>]... [-o <out>]
                channel-partner-links-customers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                channel-partner-links-get <name> [-p <v>]... [-o <out>]
                channel-partner-links-list <parent> [-p <v>]... [-o <out>]
                channel-partner-links-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                check-cloud-identity-accounts-exist <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-customer-repricing-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-customer-repricing-configs-delete <name> [-p <v>]... [-o <out>]
                customers-customer-repricing-configs-get <name> [-p <v>]... [-o <out>]
                customers-customer-repricing-configs-list <parent> [-p <v>]... [-o <out>]
                customers-customer-repricing-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-delete <name> [-p <v>]... [-o <out>]
                customers-entitlements-activate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-change-offer <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-change-parameters <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-change-renewal-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-get <name> [-p <v>]... [-o <out>]
                customers-entitlements-list <parent> [-p <v>]... [-o <out>]
                customers-entitlements-list-entitlement-changes <parent> [-p <v>]... [-o <out>]
                customers-entitlements-lookup-offer <entitlement> [-p <v>]... [-o <out>]
                customers-entitlements-start-paid-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-entitlements-suspend <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-get <name> [-p <v>]... [-o <out>]
                customers-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-list <parent> [-p <v>]... [-o <out>]
                customers-list-purchasable-offers <customer> [-p <v>]... [-o <out>]
                customers-list-purchasable-skus <customer> [-p <v>]... [-o <out>]
                customers-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-provision-cloud-identity <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-query-eligible-billing-accounts <customer> [-p <v>]... [-o <out>]
                customers-transfer-entitlements <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                customers-transfer-entitlements-to-google <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                list-subscribers <account> [-p <v>]... [-o <out>]
                list-transferable-offers <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                list-transferable-skus <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                offers-list <parent> [-p <v>]... [-o <out>]
                register <account> (-r <kv>)... [-p <v>]... [-o <out>]
                report-jobs-fetch-report-results <report-job> (-r <kv>)... [-p <v>]... [-o <out>]
                reports-list <parent> [-p <v>]... [-o <out>]
                reports-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                sku-groups-billable-skus-list <parent> [-p <v>]... [-o <out>]
                sku-groups-list <parent> [-p <v>]... [-o <out>]
                unregister <account> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
        products
                list [-p <v>]... [-o <out>]
                skus-list <parent> [-p <v>]... [-o <out>]
  cloudchannel1 --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文件中,以cloudchannel1-为前缀。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

要撤销授予的身份验证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC