redis1命令行界面（CLI）允许您在终端中舒适地使用Google Cloud Redis服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-redis1-cli

在GitHub上找到源代码。

用法

本文档是从修订版20240226的云Redis API生成的。CLI版本为5.0.4。

redis1 [options]
        projects
                locations-clusters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-clusters-delete <name> [-p <v>]... [-o <out>]
                locations-clusters-get <name> [-p <v>]... [-o <out>]
                locations-clusters-get-certificate-authority <name> [-p <v>]... [-o <out>]
                locations-clusters-list <parent> [-p <v>]... [-o <out>]
                locations-clusters-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-delete <name> [-p <v>]... [-o <out>]
                locations-instances-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-failover <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-get-auth-string <name> [-p <v>]... [-o <out>]
                locations-instances-import <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-reschedule-maintenance <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-upgrade <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <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>]
  redis1 --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文件中，文件名以redis1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

当作用域首次被使用时，会提示用户请求权限。按照CLI的指示进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误信息，但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原样输出到标准错误来完成的。

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

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