3个稳定版本
5.0.4+20240304 | 2024年3月5日 |
---|---|
3.1.0+20220305 | 2022年4月26日 |
3.0.0+20220305 | 2022年3月8日 |
2994 在 Web编程
47 每月下载量
420KB
5K SLoC
该cloudsupport2-beta
命令行界面(CLI)允许您从终端舒适地使用Google Cloud Support服务的几乎所有功能。
默认情况下,所有输出都打印到标准输出,但可以使用标志将其直接导向文件,而不受shell功能的影响。错误将打印到标准错误,并导致程序退出代码非零。
如果请求数据结构,这些结构将作为格式化的JSON返回,以作为其他工具的输入。
有关Cloud Support API的所有其他信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面:
cargo install google-cloudsupport2_beta-cli
用法
此文档是根据修订版20240304的Cloud Support API生成的。CLI的版本为5.0.4。
cloudsupport2-beta [options]
case-classifications
search [-p <v>]... [-o <out>]
cases
attachments-list <parent> [-p <v>]... [-o <out>]
close <name> (-r <kv>)... [-p <v>]... [-o <out>]
comments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
comments-list <parent> [-p <v>]... [-o <out>]
create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
escalate <name> (-r <kv>)... [-p <v>]... [-o <out>]
get <name> [-p <v>]... [-o <out>]
list <parent> [-p <v>]... [-o <out>]
patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
search [-p <v>]... [-o <out>]
media
download <name> [-p <v>]... [-o <out>]
upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
cloudsupport2-beta --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文件中,文件名以cloudsupport2-beta-
开头。您可以使用--config-dir
标志在每次调用中更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数API都需要用户对任何请求进行身份验证。如果是这种情况,则作用域确定授予的权限集。这些的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行作用域,例如,当调用只读方法时,它将仅请求只读作用域。您可以使用--scope
标志直接指定作用域。所有适用作用域均在各自方法的CLI文档中有记录。
首次使用作用域时,会要求用户授权。根据CLI的指示授权或拒绝。
如果用户认证了作用域,相关信息将作为JSON存储在配置目录中,例如:~/.google-service-cli/cloudsupport2-beta-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授权,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。为应用程序启用可能使用的API,一次一个。大多数API可以免费使用,并且有每日配额。
为了在不强制任何人注册自己的应用程序的情况下更方便地使用CLI,CLI附带了一个默认的应用程序密钥,并进行相应的配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/cloudsupport2-beta-secret.json
,前提是已为它启用了所需的cloudsupport API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON处下载并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这通过允许所有客户端-服务器通信以“原样”输出到标准错误来实现。
使用--debug
标志将错误以Debug
表示法打印到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如:cloudsupport2-beta --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~19–32MB
~594K SLoC