9 个稳定版本
3.1.0+20220225 | 2022 年 4 月 26 日 |
---|---|
3.0.0+20220225 | 2022 年 3 月 8 日 |
2.0.4+20210319 | 2021 年 4 月 14 日 |
1.0.14+20200613 | 2020 年 7 月 10 日 |
1.0.10+20190625 | 2019 年 7 月 6 日 |
#48 在 #standard-error
800KB
9K SLoC
该 cloudasset1
命令行界面(CLI)允许您在终端中舒适地使用 Google Cloud Asset 服务的几乎所有功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其直接定向到文件,而不考虑您的 shell 功能。错误将打印到标准错误,并使程序退出代码非零。
如果请求数据结构,则这些结构将作为格式化的 JSON 返回,以便作为其他工具的输入使用。
有关云资产 API 的其他信息,请参阅官方文档站点。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-cloudasset1-cli
在 GitHub 上找到源代码。
用法
本文档是根据修订版 20220225 中的 Cloud Asset API 生成的。CLI 的版本为 3.1.0。
cloudasset1 [options]
assets
list <parent> [-p <v>]... [-o <out>]
effective-iam-policies
batch-get <scope> [-p <v>]... [-o <out>]
feeds
create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
delete <name> [-p <v>]... [-o <out>]
get <name> [-p <v>]... [-o <out>]
list <parent> [-p <v>]... [-o <out>]
patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
methods
analyze-iam-policy <scope> [-p <v>]... [-o <out>]
analyze-iam-policy-longrunning <scope> (-r <kv>)... [-p <v>]... [-o <out>]
analyze-move <resource> [-p <v>]... [-o <out>]
batch-get-assets-history <parent> [-p <v>]... [-o <out>]
export-assets <parent> (-r <kv>)... [-p <v>]... [-o <out>]
search-all-iam-policies <scope> [-p <v>]... [-o <out>]
search-all-resources <scope> [-p <v>]... [-o <out>]
operations
get <name> [-p <v>]... [-o <out>]
saved-queries
create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
delete <name> [-p <v>]... [-o <out>]
get <name> [-p <v>]... [-o <out>]
list <parent> [-p <v>]... [-o <out>]
patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
cloudasset1 --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 文件中,文件名以 cloudasset1-
前缀开头。您可以使用 --config-dir
标志根据每次调用更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这种情况,则 范围 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。
如果未设置,系统将自动选择最小的可行范围,例如,当调用只读方法时,它只会请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用的范围均在相应方法的 CLI 文档中记录。
第一次使用范围时,用户会被要求授予权限。按照 CLI 提供的说明授予权限,或拒绝。
如果作用域被用户认证,相关信息将被存储在配置目录中的 JSON 格式,例如 ~/.google-service-cli/cloudasset1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,它需要使用 Google 开发者控制台 进行注册。为该应用程序逐一启用可能使用的 API。大多数 API 可免费使用,并且有每日配额。
为了在不强制用户注册自己的应用程序的情况下,更方便地使用 CLI,CLI 随带一个默认的应用程序密钥,相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放置在此位置来解决这个问题: ~/.google-service-cli/cloudasset1-secret.json
,假设已为它启用了所需的 cloudasset API。这样的密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅官方文档。
调试
尽管 CLI 尽力提供可用的错误消息,但有时了解导致特定问题的确切原因可能很有用。这是通过允许所有客户端-服务器通信以 原始形式 输出到标准错误来完成的。
使用 --debug
标志将使用 Debug
表示法将错误打印到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如 cloudasset1 --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~18–31MB
~565K SLoC