该 run1 命令行界面 (CLI) 允许您在终端中轻松使用Google Cloud Run服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其定向到文件，而与shell的功能无关。错误将打印到标准错误，并导致程序退出代码不为零。

如果请求数据结构，则这些结构将作为美观打印的JSON返回，以便作为其他工具的输入。

有关Cloud Run API的其他所有信息，请参阅官方文档网站。

安装和源代码

使用cargo通过以下命令安装命令行界面：

cargo install google-run1-cli

在GitHub上找到源代码。

用法

本文档是从Cloud Run API的20240225版本生成的。CLI的版本是5.0.4。

run1 [options]
        namespaces
                authorizeddomains-list <parent> [-p <v>]... [-o <out>]
                configurations-get <name> [-p <v>]... [-o <out>]
                configurations-list <parent> [-p <v>]... [-o <out>]
                domainmappings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                domainmappings-delete <name> [-p <v>]... [-o <out>]
                domainmappings-get <name> [-p <v>]... [-o <out>]
                domainmappings-list <parent> [-p <v>]... [-o <out>]
                executions-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                executions-delete <name> [-p <v>]... [-o <out>]
                executions-get <name> [-p <v>]... [-o <out>]
                executions-list <parent> [-p <v>]... [-o <out>]
                jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-delete <name> [-p <v>]... [-o <out>]
                jobs-get <name> [-p <v>]... [-o <out>]
                jobs-list <parent> [-p <v>]... [-o <out>]
                jobs-replace-job <name> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                revisions-delete <name> [-p <v>]... [-o <out>]
                revisions-get <name> [-p <v>]... [-o <out>]
                revisions-list <parent> [-p <v>]... [-o <out>]
                routes-get <name> [-p <v>]... [-o <out>]
                routes-list <parent> [-p <v>]... [-o <out>]
                services-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                services-delete <name> [-p <v>]... [-o <out>]
                services-get <name> [-p <v>]... [-o <out>]
                services-list <parent> [-p <v>]... [-o <out>]
                services-replace-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
                tasks-get <name> [-p <v>]... [-o <out>]
                tasks-list <parent> [-p <v>]... [-o <out>]
        projects
                authorizeddomains-list <parent> [-p <v>]... [-o <out>]
                locations-authorizeddomains-list <parent> [-p <v>]... [-o <out>]
                locations-configurations-get <name> [-p <v>]... [-o <out>]
                locations-configurations-list <parent> [-p <v>]... [-o <out>]
                locations-domainmappings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-domainmappings-delete <name> [-p <v>]... [-o <out>]
                locations-domainmappings-get <name> [-p <v>]... [-o <out>]
                locations-domainmappings-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-jobs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-operations-wait <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-revisions-delete <name> [-p <v>]... [-o <out>]
                locations-revisions-get <name> [-p <v>]... [-o <out>]
                locations-revisions-list <parent> [-p <v>]... [-o <out>]
                locations-routes-get <name> [-p <v>]... [-o <out>]
                locations-routes-list <parent> [-p <v>]... [-o <out>]
                locations-services-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-delete <name> [-p <v>]... [-o <out>]
                locations-services-get <name> [-p <v>]... [-o <out>]
                locations-services-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-services-list <parent> [-p <v>]... [-o <out>]
                locations-services-replace-service <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-services-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  run1 --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文件中，文件名以run1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会要求用户进行授权。遵循CLI给出的说明进行授权，或拒绝授权。

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

要撤销授权的认证，请参阅官方文档。

应用程序密钥

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

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI自带了一个相应的默认应用程序密钥。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/run1-secret.json，前提是该应用程序已启用了所需的run API。这样的密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON处下载，并直接使用。

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

调试

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

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

您可以考虑将标准错误重定向到文件，以便于使用，例如run1 --debug <资源> <方法> [选项] 2>debug.txt。