文档

通过redis-cli连接Redis

更新时间:

redis-cli是原生Redis自带的命令行工具,您可以在ECS实例或本地设备上通过redis-cli连接云数据库Tair(兼容 Redis)管理Redis数据库。本文介绍安装redis-cli及通过redis-cli连接Redis实例的操作步骤以及常见的连接报错。

免费试用

阿里云免费试用面向符合条件的新用户,提供一定时间段的免费试用阿里云产品的权益,更多信息请参见免费试用

快速了解连接Redis实例流程

连接Redis实例的流程

操作流程

说明

1. 设置Redis账号密码。

选择以下任意方式:

2. 添加白名单。

根据不同设备确定连接的网络类型,并将对应网络IP地址添加至Redis实例中。

  • ECS实例(推荐):推荐使用 专有网络VPC

    请确保ECS实例与Redis实例属于同一专有网络,并将ECS实例的私网IP地址添加至Redis实例的白名单中。

    说明

    如果ECS实例与Redis实例不属于同一专有网络(例如ECS实例与Redis实例为不同地域),可将ECS实例的公网IP地址添加至Redis实例的白名单中,并通过ECS公网连接Redis实例的公网连接地址。

  • 本地设备:可使用 公网

    将本地设备的公网IP地址添加至Redis实例的白名单中。

关于添加白名单的具体操作,请参见设置IP白名单

3. 获取Redis连接信息。

  • 使用专有网络连接时:在Redis控制台,获取该实例的专有网络连接地址

  • 使用公网连接时:在Redis控制台,申请并获取该实例的公网连接地址

    说明

    Redis实例默认仅提供专有网络连接地址,通过公网连接时您需要手动申请公网连接地址。

具体操作,请参见查看连接地址

4. 使用redis-cli连接Redis实例。

在redis-cli解压目录下执行相关命令。

  • 连接命令:redis-cli -h hostname -p port

    连接命令示例:redis-cli -h r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com -p 6379

  • 密码命令:AUTH user:password

    密码命令示例:AUTH testaccount:Rp829dlwa

具体操作,请参见本文连接操作

准备工作

如果您的设备未安装redis-cli,请参考下述安装说明进行安装。

redis-cli安装说明

在ECS实例或本地设备上,安装Redis会同步安装redis-cli。通过redis-cli连接时,redis-cli的版本无需与云数据库Tair(兼容 Redis)实例版本相同。

  1. 登录待安装redis-cli的设备,例如ECS实例或本地设备。

  2. 下载、安装redis-cli。

    Windows系统

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

    1. 下载Redis-x64-3.2.100.zip文件。

      说明

      本文以redis-3.2版本为例演示操作流程,您也可以安装其他版本。更多信息,请参见MicrosoftArchive-Redis

    2. Redis-x64-3.2.100.zip解压至待安装的目录。

    macOS系统

    在Mac上安装Redis客户端的一个常用且简便的方法是通过Homebrew,Homebrew是一个mac OS的包管理器。下面是详细的步骤:

    安装Homebrew(如果尚未安装)

    1. 打开终端(Terminal)。

    2. 复制并粘贴以下命令到终端,然后按回车键。这个命令会下载并运行Homebrew的安装脚本。

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    1. 按照屏幕提示操作,可能需要输入密码。

    使用Homebrew安装Redis

    在终端中,输入以下命令来安装Redis服务器:

    brew install redis

    这个命令会下载Redis的最新稳定版本并安装到你的系统中。安装成功后可在终端输入命令which redis-cli获取redis-cli的位置。

    Linux系统

    执行下述命令,安装gcc依赖环境。

    sudo yum -y install gcc

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

    wget https://download.redis.io/releases/redis-7.0.0.tar.gz
    说明

    本文以redis-7.0.0版本为例演示操作流程,您也可以安装其他版本。具体操作,请参见Redis官网

    执行下述命令解压Redis源码文件。

    tar xzf redis-7.0.0.tar.gz

    执行下述命令进入解压后的目录并编译安装Redis源码文件:

    cd redis-7.0.0&&make
    说明

    编译安装需要一段时间(通常为2分钟~3分钟)。

连接操作

  1. 进入redis-cli安装目录下。

    Windows系统

    打开命令行窗口,进入redis-cli所属的目录。

    macOS系统

    进入../redis-cli所属的目录,例如cd /opt/homebrew/bin

    Linux系统

    进入..\redis-7.0.0\src所属的目录,例如cd /home/redis-7.0.0/src

  2. 执行下述命令通过redis-cli连接Redis实例:

    ./redis-cli -h hostname -p port [-c]
    说明

    在Windows中使用PowerShell启动redis-cli的命令为.\redis-cli -h hostname -p port [-c]

    表 1. 参数说明

    参数

    说明

    获取方式

    hostname

    Redis实例的连接地址

    • 通过专有网络连接:需获取Redis实例的专有网络连接地址。

    • 通过公网连接:需获取Redis实例的公网连接地址。

    具体操作,请参见查看连接地址

    port

    Redis实例的端口号

    端口号默认为6379,您也可以自定义端口号。具体操作,请参见修改连接地址或端口

    -c

    启用集群模式

    该模式仅当Redis实例为集群架构,且使用直连地址连接时可用。

    连接示例:

    • 默认地址(适用于通过默认地址连接的场景,例如标准架构实例的连接地址或集群架构实例的代理地址):

      ./redis-cli -h r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com -p 6379
    • 集群架构直连地址(适用于集群架构通过直连地址连接的场景):

      ./redis-cli -h r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com -p 6379 -c
  3. 执行下述命令完成密码验证:

    AUTH password

    表 2. 参数说明

    参数

    说明

    password

    根据选取账号类型,填写账号、密码:

    • 默认账号(通常为default或以实例ID命名的账号):直接填写密码即可。

    • 普通账号:密码格式为user:password。例如自定义账号为testaccount,密码为Rp829dlwa,密码需填写为testaccount:Rp829dlwa

    说明
    • 如果忘记或未设置密码,您可以重置密码。具体操作,请参见修改或重置密码

    • 如果实例已开启专有网络免密访问,通过专有网络连接Redis实例时无需执行本步骤即可执行Redis命令。

    示例:

    AUTH testaccount:Rp829dlwa

    显示OK表示已成功连接Redis实例,可执行Redis命令。

常见报错

说明

如果实例的小版本过低,报错信息可能与下表不一致,建议将实例升级至最新的小版本。具体操作,请参见升级小版本与代理版本

报错信息

原因及解决方法

(error) ERR illegal address

未添加正确的白名单,请参见快速了解连接Redis实例流程中第2步添加正确的白名单。

(error) ERR client ip is not in whitelist

  • (error) ERR invalid password

  • (error) WRONGPASS invalid username-password pair

密码错误,请使用正确的密码和密码格式。根据选取账号类型的不同,密码格式有一定区别。

  • 默认账号(通常为default或以实例ID命名的账号):直接填写密码即可。

  • 普通账号:密码格式为user:password。例如自定义账号为testaccount,密码为Rp829dlwa,密码需填写为testaccount:Rp829dlwa

说明
  • 如果通过第三方数据库管理工具(例如RDM等)连接Redis实例,请在密码框中输入user:password进行连接。

  • 如果忘记密码,您可以重置密码。具体操作,请参见修改或重置密码