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

5.0.4+20240302 2024年3月5日
3.1.0+20220225 2022年4月26日
3.0.0+20220225 2022年3月8日
2.0.4+20210319 2021年4月14日
1.0.8+20181008 2018年10月14日

#2922 in Web编程

每月30次下载

MIT 许可证

320KB
3.5K SLoC

cloudasset1-beta1 命令行界面(CLI)允许您在终端中方便地使用Google Cloud Asset服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-cloudasset1_beta1-cli

github上找到源代码。

用法

本文档是根据修订版20240302的云资源API生成的。CLI版本为5.0.4

cloudasset1-beta1 [options]
        folders
                export-assets <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
        organizations
                batch-get-assets-history <parent> [-p <v>]... [-o <out>]
                export-assets <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
        projects
                batch-get-assets-history <parent> [-p <v>]... [-o <out>]
                export-assets <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
  cloudasset1-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目录中存储所有持久数据,这些目录以cloudasset1-beta1-为前缀的JSON文件。您可以使用--config-dir标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户会被要求授权。遵循CLI给出的指示授权或拒绝。

如果用户验证了范围,相关的信息将以 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/cloudasset1-beta1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

为了在不强制要求用户注册自己的应用程序的情况下更方便地使用CLI,CLI带有默认的应用程序密钥,并根据需要进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

尽管CLI尽最大努力提供可用的错误消息,但有时了解导致特定问题的确切原因可能更有意义。这是通过允许所有客户端-服务器通信以原样输出到标准错误。

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

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

依赖项

~20–31MB
~577K SLoC