19个稳定版本 (4个主要版本)

5.0.4+20240303 2024年3月5日
3.1.0+20220306 2022年4月26日
2.0.4+20210328 2021年4月15日
1.0.14+20200629 2020年7月10日
0.3.6+20160617 2016年9月11日

#2891 in Web编程

Download history 10/week @ 2024-03-12 23/week @ 2024-03-26 135/week @ 2024-04-02 1/week @ 2024-05-21

每月407次 下载

MIT 许可证

1MB
12K SLoC

cloudresourcemanager1 命令行界面(CLI)允许您从终端舒适地使用大多数Google Cloud Resource Manager服务的功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-cloudresourcemanager1-cli

GitHub上找到源代码

用法

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

cloudresourcemanager1 [options]
        folders
                clear-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-effective-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list-available-org-policy-constraints <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list-org-policies <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                set-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        liens
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        operations
                get <name> [-p <v>]... [-o <out>]
        organizations
                clear-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-effective-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list-available-org-policy-constraints <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list-org-policies <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                search (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                set-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                clear-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <project-id> [-p <v>]... [-o <out>]
                get <project-id> [-p <v>]... [-o <out>]
                get-ancestry <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                get-effective-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                list-available-org-policy-constraints <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list-org-policies <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                set-org-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                undelete <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudresourcemanager1 --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目录中,以cloudresourcemanager1前缀命名的JSON文件中。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户将被要求授予权限。按照 CLI 的说明授予权限或拒绝。

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

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

应用程序密钥

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

为了在不强制任何人注册自己的应用程序的情况下更方便地使用 CLI,CLI 配置了默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

尽管 CLI 尽力提供可用的错误消息,但有时可能需要知道导致特定问题的确切原因。这通过允许所有客户端-服务器通信以 原样 输出到标准错误来实现。

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

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

依赖项

~19–31MB
~581K SLoC