11 个稳定版本 (3 个主要版本)
5.0.4+20230123 | 2024年3月5日 |
---|---|
3.1.0+20220301 | 2022年4月26日 |
3.0.0+20220301 | 2022年3月8日 |
2.0.4+20210319 | 2021年4月15日 |
1.0.8+20181010 | 2018年10月14日 |
#2834 in 网络编程
218 每月下载次数
410KB
5.5K SLoC
该 accesscontextmanager1-beta
命令行界面(CLI)允许您在终端中舒适地使用 Google Access Context Manager 服务的大部分功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接重定向到文件,而不受您的 shell 功能的限制。错误将打印到标准错误,并导致程序的退出代码为非零。
如果请求数据结构,这些将作为格式化良好的 JSON 返回,以便作为其他工具的输入。
有关 Google Access Context Manager API 的其他所有信息,请参阅官方文档网站。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-accesscontextmanager1_beta-cli
在 github 上查找源代码。
用法
本文档是从修订版 20230123 的 访问上下文管理器 API 生成的。CLI 的版本为 5.0.4。
accesscontextmanager1-beta [options]
access-policies
access-levels-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
access-levels-delete <name> [-p <v>]... [-o <out>]
access-levels-get <name> [-p <v>]... [-o <out>]
access-levels-list <parent> [-p <v>]... [-o <out>]
access-levels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
create (-r <kv>)... [-p <v>]... [-o <out>]
delete <name> [-p <v>]... [-o <out>]
get <name> [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
service-perimeters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
service-perimeters-delete <name> [-p <v>]... [-o <out>]
service-perimeters-get <name> [-p <v>]... [-o <out>]
service-perimeters-list <parent> [-p <v>]... [-o <out>]
service-perimeters-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
operations
get <name> [-p <v>]... [-o <out>]
accesscontextmanager1-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 文件中,文件名以 accesscontextmanager1-beta-
为前缀。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种类型持久数据的更多信息。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这种情况,作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。
如果未设置,系统将自动选择最小的可行范围,例如,在调用只读方法时,它将只请求只读范围。您可以使用 --scope
标志直接指定范围。所有适用的范围均在相应方法的 CLI 文档中有说明。
第一次使用范围时,会要求用户授权。按照 CLI 提供的说明授权或拒绝。
如果用户认证了范围,相应的信息将被存储在配置目录中,格式为 JSON,例如 ~/.google-service-cli/accesscontextmanager1-beta-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授权的认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,它需要使用 Google 开发者控制台 进行注册。然后逐一为应用程序启用可能使用的 API。大多数 API 可以免费使用,并且有每日配额。
为了在不强制任何人注册自己的应用程序的情况下更方便地使用 CLI,CLI 配备了一个默认的应用程序密钥,并进行相应的配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/accesscontextmanager1-beta-secret.json
,假设已为其启用了所需的 accesscontextmanager API。这样的密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 下下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅官方文档。
调试
尽管 CLI 尽最大努力提供可用的错误消息,但有时了解导致特定问题的确切原因可能很有用。这是通过允许所有客户端-服务器通信以标准错误输出 原样 来完成的。
使用 --debug
标志会将错误以 Debug
表示形式输出到标准错误。
您可以考虑将标准错误重定向到文件,以便于使用,例如 accesscontextmanager1-beta --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~20–31MB
~579K SLoC