19个稳定版本 (4个主要)
5.0.4+20160512 | 2024年3月5日 |
---|---|
3.0.0+20160512 | 2022年3月8日 |
2.0.4+20160512 | 2021年4月15日 |
1.0.14+20160512 | 2020年7月10日 |
0.3.6+20160512 | 2016年9月11日 |
2061 在 网络编程
398 每月下载量
310KB
4.5K SLoC
该resourceviews1-beta2
命令行界面(CLI)允许您从终端轻松使用Google资源视图服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接重定向到文件,而不受shell功能的限制。错误将打印到标准错误,并导致程序的退出代码不为零。
如果请求数据结构,则这些数据结构将作为格式化的JSON返回,以便作为其他工具的输入。
有关resourceviews API的其他信息,请参阅官方文档站点。
安装和源代码
使用cargo安装命令行界面
cargo install google-resourceviews1_beta2-cli
在github上查找源代码。
用法
本文档是根据修订版20160512的resourceviews API生成的。CLI版本为5.0.4。
resourceviews1-beta2 [options]
zone-operations
get <project> <zone> <operation> [-p <v>]... [-o <out>]
list <project> <zone> [-p <v>]... [-o <out>]
zone-views
add-resources <project> <zone> <resource-view> (-r <kv>)... [-p <v>]... [-o <out>]
delete <project> <zone> <resource-view> [-p <v>]... [-o <out>]
get <project> <zone> <resource-view> [-p <v>]... [-o <out>]
get-service <project> <zone> <resource-view> [-p <v>]... [-o <out>]
insert <project> <zone> (-r <kv>)... [-p <v>]... [-o <out>]
list <project> <zone> [-p <v>]... [-o <out>]
list-resources <project> <zone> <resource-view> [-p <v>]... [-o <out>]
remove-resources <project> <zone> <resource-view> (-r <kv>)... [-p <v>]... [-o <out>]
set-service <project> <zone> <resource-view> (-r <kv>)... [-p <v>]... [-o <out>]
resourceviews1-beta2 --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文件中,文件名以resourceviews1-beta2-
开头。您可以使用--config-dir
标志根据调用更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数API需要用户对请求进行身份验证。如果是这种情况,则范围确定授予的权限集。这些的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行范围,例如,当调用只读方法时,它将仅请求只读范围。您可以使用--scope
标志直接指定范围。所有适用范围在各自方法的CLI文档中均有记录。
第一次使用作用域时,系统会询问用户是否授权。根据命令行界面(CLI)的指示进行授权或拒绝。
如果用户已对作用域进行认证,相关配置信息将以JSON格式存储在配置目录中,例如:~/.google-service-cli/resourceviews1-beta2-token-<scope-hash>.json
。无需手动管理这些令牌。
若要撤销授权认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用谷歌服务,它需要使用谷歌开发者控制台进行注册。然后逐个启用该应用程序可能使用的API。大多数API可以免费使用,并设有每日配额。
为了使CLI更易于使用,无需强制注册自己的应用程序,CLI自带默认应用程序密钥,并相应地配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过将自带的密钥文件放在以下位置来解决这个问题:~/.google-service-cli/resourceviews1-beta2-secret.json
,假设已经为它启用了所需的resourceviews API。此类密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON中下载,并直接使用。
有关如何设置谷歌项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽最大努力提供可用的错误消息,但有时了解导致特定问题的确切原因可能很有帮助。这是通过允许所有客户端服务器通信直接输出到标准错误来完成的。
使用--debug
标志,将错误以Debug
表示形式打印到标准错误。
您可以考虑将标准错误重定向到文件,以便于使用,例如:resourceviews1-beta2 --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~20–31MB
~582K SLoC