You need to enable JavaScript to run this app.
导航
通过 Redis-cli 连接实例
最近更新时间:2024.06.03 11:31:29首次发布时间:2021.11.04 14:15:17

Redis-cli 是社区原生 Redis 自带的命令行工具,您可以在 ECS 实例或本地设备上通过 redis-cli 连接缓存数据库 Redis 版,进行数据管理。

连接 Redis 使用的网络类型

网络类型
说明
私有网络私有网络 VPC(Virtual Private Cloud)是独享的私有网络。当 redis-cli 部署在 ECS 实例上时,通过私有网络连接至 Redis 实例,可获得更高的安全性和更好的性能。

公网

公网即互联网。您可以在本地设备上部署 redis-cli,并通过公网连接 Redis 实例进行测试。

说明

公网访问不会产生流量费用,但相较于私网访问,公网访问的延迟更高且存在一定的安全隐患,建议仅在测试环境中使用,生产环境推荐使用私网访问。当 VPC 外的设备不再需要访问 Redis 实例时,建议您及时关闭公网访问功能。

准备工作

根据 redis-cli 的安装位置,完成相关准备工作。

说明

  • 由于 redis-cli 是原生 Redis 自带的命令行工具,通常您需要通过在 ECS 实例或本地设备上安装 Redis 服务的方式,完成 redis-cli 的安装。具体安装方法,请参见附录:安装 redis-cli
  • Redis-cli 的版本可以与 Redis 实例的版本不同。
Redis-cli 安装位置
需完成的操作

ECS 实例(推荐)

  1. 确保 ECS 实例与 Redis 实例属于同一 VPC 网络中。
  2. 获取 ECS 实例的内网 IP 地址。
  3. 将 ECS 实例的内网 IP 地址添加至 Redis 实例的白名单中。设置白名单的方法,请参见设置白名单

本地

  1. 缓存数据库 Redis 版默认仅提供私网地址。本地应用程序访问 Redis 实例前,需要先为 Redis 实例开启公网访问。开启公网访问的方法,请参见开启公网访问
  2. 打开本地设备的命令行窗口或命令终端,参考如下方法选择合适的命令获取本地设备公网 IP 地址:
    • Linux 操作系统:在命令终端中执行 curl ifconfig.me 命令。
    • Windows 操作系统:在命令行窗口中执行 curl ip.me 命令。
    • MacOS 操作系统:在命令终端中执行 curl ifconfig.me 命令。
  3. 将本地客户端的公网 IP 地址添加到 Redis 实例的 IP 白名单中。设置白名单的方法,请参见设置白名单

注意事项

若需要在开启 SSL 加密后,使用 redis-cli 客户端连接实例,那么:

  • Redis-cli 6 以下版本的客户端不支持连接时验证证书,请使用 redis-cli 6 或以上版本的客户端。
  • 连接实例前,需要先执行 make BUILD_TLS=yes 命令编译 redis-cli 客户端文件。
    设置 SSL 加密的方法,请参见设置 SSL 加密

操作步骤

  1. 登录已安装了 redis-cli 的设备,例如 ECS 实例或本地设备。
    如未安装 redis-cli,请参见附录:安装 redis-cli 进行安装。

  2. 打开本地设备的命令行窗口或命令终端工具,并通过进入 redis-cli 安装目录下。
    不同操作系统进入安装目录命令参考如下:

    • Windows 操作系统:cd /d <redis-cli 所属的目录>,例如 cd /d D:redis-6.2.13
    • Linux 操作系统: cd ../<redis-cli 所属的目录>,例如 cd root/redis-6.2.13
    • macOS 操作系统: cd ../<redis-cli 所属的目录>,例如 cd home/redis-6.2.13
  3. 获取连接信息并执行下述命令连接 Redis 实例。获取连接地址的具体方法,请参见查看连接地址

    src/redis-cli -h <hostname> -p <port> [-c]
    
    参数
    说明
    获取方式

    <hostname>

    Redis 实例的连接地址

    • ECS 实例通过私有网络连接:需获取 Redis 实例的私有网络连接地址。
    • 本地设备通过公网连接:需开启公网访问来获取 Redis 实例的公网连接地址。开启公网访问的方法,请参见开启公网访问
    <port>Redis 实例的端口号默认端口号为 6379。
    -c启用集群模式只有启用分片集群的 Redis 实例会使用该参数,当您需要使用直连地址连接时,需要在连接实例时加上 -c。关于直连地址的更多信息,请参见申请直连地址

    不同类型连接地址的连接代码示例如下,关于连接地址类型的更多信息,请参见连接地址类型

    • 私网或公网地址连接示例
      src/redis-cli -h redis-cng6qap*****.redis.ivolces.com -p 6379
      
    • 直连地址连接示例
      src/redis-cli -h redis-cng6qap*****.redis.ivolces.com -p 6379 -c
      
  4. 执行 AUTH 命令完成账密验证。
    您可以选择如下任一方式完成账密校验:

    • 同时输入账号和密码进行验证,命令如下。
      AUTH <username> <password>
      
      AUTH <username>:<password>
      
    • 直接填写密码进行验证,命令如下。
      AUTH <password>
      

    说明

    • 仅使用 default 默认账号时支持直接填写密码进行验证。
    • 如果忘记密码,您可以重置密码。具体操作,请参见修改或重置密码

    示例如下。

    AUTH testuser Test@Password
    

    验证成功后,会返回 OK

后续操作

完成验证后即可执行 Redis 命令,例如执行 DBSIZE 命令查询当前库有多少个键(Key)。关于缓存数据库 Redis 版支持的命令详情,请参见命令支持

附录:安装 redis-cli

说明

  • 在 ECS 实例或本地设备上,安装 Redis 会同步安装 redis-cli。通过 redis-cli 连接时,redis-cli 的版本无需与缓存数据库 Redis 版实例版本相同。
  • 本文操作步骤中以 redis-6.2.13 版本为例,您也可以根据业务需要安装其他版本。更多信息,请参见Redis downloads
  1. 登录待安装 redis-cli 的设备,例如 ECS 实例或本地设备。

  2. 根据操作设备使用的操作系统,选择对应的方法完成下载和安装 redis-cli。

    1. Linux

      • 执行下述命令下载 Redis 源码文件。

        wget https://download.redis.io/releases/redis-6.2.13.tar.gz
        
      • 执行下述命令解压 Redis 源码文件。

        tar xzf redis-6.2.13.tar.gz
        
      • 执行下述命令进入解压后的目录并编译安装 Redis 源码文件。

        cd redis-6.2.13 && make
        
    2. Windows

      说明

      目前仅支持 64 位的 Windows 系统。

      1. 下载 Redis-x64-3.0.zip文件。
      2. 将 Redis-x64-3.0.zip 解压至待安装的目录。