主要接口
更新时间：2025-08-05
云数据库 Redis（Simple Cache Service）提供稳定、高效以及高可扩展性的分布式缓存服务。云数据库 Redis 兼容 Redis/Memcached 协议，基于 Redis 提供标准版和集群版的架构模式，并支持自定义副本数量，为您提供多样化的数据结构支持。
订单服务
创建实例
使用以下代码可以创建Redis实例，用于创建一个或多个redis实例
Go
1args := &scs.CreateInstanceArgs{
2 // 选择付款方式，可以选择预付费或后付费
3 Billing: api.Billing{
4 PaymentTiming: api.PaymentTimingPostPaid,
5 },
6 // 购买个数，最大不超过10，默认1
7 PurchaseCount: 1,
8 // 实例名
9 // 要求：1）支持大小写字母、数字以及-_ /.等特殊字符，必须以字母开头；2）长度限制为1-64；
10 InstanceName: "sdk-scs",
11 // 端口号 1025<port<22222，22222<port<65535
12 Port: 6379,
13 // 引擎版本，集群：3.2、4.0、5.0 主从：2.8、3.2、4.0、5.0
14 EngineVersion: "3.2",
15 // 节点规格
16 NodeType: "cache.n1.micro",
17 // 集群类型，集群版："cluster"，主从版："master_slave"
18 ClusterType: "master_slave",
19 // 副本个数，单副本为1，双副本为2，多副本依此类推
20 ReplicationNum: 1,
21 // 分片个数
22 ShardNum: 1,
23 // 代理节点数，主从版：0，集群版：代理节点数=分片个数
24 ProxyNum: 0,
25}
26
27// 若要生成预付费实例，可以按以下配置生成一个月的预付费实例
28args.Billing = api.Billing{
29 PaymentTiming: api.PaymentTimingPrePaid,
30 Reservation: &api.Reservation{
31 ReservationLength: 1,
32 ReservationTimeUnit: "month",
33 }
34 }
35
36// 若要设置自动续费，可以按以下参数设置一年内自动续费
37// 按月付费或者按年付费 月是"month"，年是"year"
38// 自动续费的时间 按月是1-9 按年是 1-3
39args.AutoRenewTimeUnit = "year"
40args.AutoRenewTime = 1
41
42result, err := client.CreateInstance(args)
43if err != nil {
44 fmt.Println("create instance failed:", err)
45} else {
46 fmt.Println("create instance success: ", result)
47}提示：
变更配置
Go
1args := &scs.ResizeInstanceArgs{
2 NodeType:"cache.n1.small",
3 ShardNum:2,
4}
5err := client.ResizeInstance(instanceId, args)
6if err != nil {
7 fmt.Println("resize instance failed:", err)
8} else {
9 fmt.Println("resize instance success")提示：
- 实例计费方式为预付费时，不能进行缩容操作
- 实例计费方式为后付费时，可弹性扩缩容
- 只有实例正常运行状态时才可以进行扩缩容操作，变更接口为异步变更，可通过查询指定实例详情接口查询实例状态
释放实例
如下代码可以释放实例,实例将自动进入回收站，保留7天后删除
Go
1err := client.DeleteInstance(instanceId)
2if err != nil {
3 fmt.Println("delete instance failed:", err)
4} else {
5 fmt.Println("delete instance success")
6}提示：
- 释放单个Redis实例，释放后实例将进入回收站，保留7天后自动删除所有物理资源。
- 可以从回收站内恢复实例或者彻底删除实例,预付费实例需要通过续费实例接口进行恢复。
实例服务
查询实例列表
以下代码可以查询Redis实例列表
Go
1args := &scs.ListInstancesArgs{}
2
3result, err := client.ListInstances(args)
4if err != nil {
5 fmt.Println("list instance failed:", err)
6} else {
7 fmt.Println("list instance success: ", result)
8}查询指定实例详情
使用以下代码可以查询指定Redis虚机的详细信息
Go
1result, err := client.GetInstanceDetail(instanceId)
2if err != nil {
3 fmt.Println("get instance detail failed:", err)
4} else
5 fmt.Println("get instance detail success ", result)
6}修改实例名称
如下代码可以修改实例名称
Go
1args := &scs.UpdateInstanceNameArgs{
2 InstanceName: "newInstanceName",
3}
4err := client.UpdateInstanceName(instanceId, args)
5if err != nil {
6 fmt.Println("update instance name failed:", err)
7} else {
8 fmt.Println("update instance name success")
9}提示：
- 只有实例Running状态时可以修改实例名称
查询实例套餐规格
如下代码可以查询当前可以创建的实例的套餐的规格
Go
1result, err := client.GetNodeTypeList()
2if err != nil {
3 fmt.Println("list node type failed: ", err)
4} else {
5 fmt.Println("list node type success: ", result)
6}获取子网列表
如下代码可以获取子网列表
Go
1args := &scs.ListSubnetsArgs{}
2_, err := client.ListSubnets(args)
3if err != nil {
4 fmt.Println("get subnet list failed:", err)
5} else {
6 fmt.Println("get subnet list success")
7}提示：
- 请求参数 vpcId 和 zoneName 不是必须的
修改实例域名
如下代码可以修改实例域名
Go
1args := &scs.UpdateInstanceDomainNameArgs{
2 Domain: "newDomainName",
3}
4err := client.UpdateInstanceDomainName(instanceId, args)
5if err != nil {
6 fmt.Println("update instance domain name failed:", err)
7} else {
8 fmt.Println("update instance domain name success")
9}提示：
- 只有实例Running状态时可以修改实例域名
获取可用区列表
使用以下代码可以获取可用区列表
Go
1result, err := client.GetZoneList()
2if err != nil {
3 fmt.Println("get zone list failed:", err)
4} else
5 fmt.Println("get zone list success ", result)
6}清空实例
如下代码可以清空实例
Go
1args := &scs.FlushInstanceArgs{
2 Password: "Password",
3}
4result, err := client.FlushInstance(instanceId, args)
5if err != nil {
6 fmt.Println("flush instance failed:", err)
7} else
8 fmt.Println("flush instance success ", result)
9}提示：
- 对redis实例，清空后表现为数据占用内存下降，数据被清空；对memcache实例，清空后表现为占用内存不会下降，但是数据被清空
- 如果没有设置密码，传递空字符串
绑定标签
如下代码可以绑定标签
Go
1args := &scs.BindingTagArgs{
2 ChangeTags: []model.TagModel{
3 {
4 TagKey: "tag1",
5 TagValue: "var1",
6 },
7 },
8}
9result, err := client.BindingTag(instanceId, args)
10if err != nil {
11 fmt.Println("bind tags failed:", err)
12} else
13 fmt.Println("bind tags success ", result)
14}解绑标签
如下代码可以解绑标签
Go
1args := &scs.BindingTagArgs{
2 ChangeTags: []model.TagModel{
3 {
4 TagKey: "tag1",
5 TagValue: "var1",
6 },
7 },
8}
9result, err := client.UnBindingTag(instanceId, args)
10if err != nil {
11 fmt.Println("unbind tags failed:", err)
12} else
13 fmt.Println("unbind tags success ", result)
14}提示：
- 解绑实例上定义的标签
- 可以同时解绑多个标签
网络安全
修改访问密码
如下代码可以修改访问密码
Go
1args := &scs.ModifyPasswordArgs{
2 Password: "newPassword",
3}
4result, err := client.ModifyPassword(instanceId, args)
5if err != nil {
6 fmt.Println("modify password failed:", err)
7} else
8 fmt.Println("modify password success ", result)
9}提示：
- 密码长度8～16位，至少包含字母、数字和特殊字符中两种。允许的特殊字符包括 $^*()_+-=
查询IP白名单
如下代码可以查询允许访问实例的IP白名单
Go
1result, err := client.GetSecurityIp(instanceId)
2if err != nil {
3 fmt.Println("get security IP failed:", err)
4} else
5 fmt.Println("get security IP success ", result)
6}提示：
- 返回参数 IP白名单列表, 包括常规地址: 如192.168.0.1，CIDR地址: 如192.168.1.0/24，0.0.0.0/0代表允许所有地址
增加IP白名单
如下代码可以增加访问实例的IP白名单
Go
1args := &scs.SecurityIpArgs{
2 SecurityIps: []string{
3 "192.0.0.1",
4 },
5}
6result, err := client.AddSecurityIp(instanceId, args)
7if err != nil {
8 fmt.Println("add security IP failed:", err)
9} else
10 fmt.Println("add security IP success ", result)
11}删除IP白名单
如下代码可以删除访问实例的IP白名单
Go
1args := &scs.SecurityIpArgs{
2 SecurityIps: []string{
3 "192.0.0.1",
4 },
5}
6result, err := client.DeleteSecurityIp(instanceId, args)
7if err != nil {
8 fmt.Println("delete security IP failed:", err)
9} else
10 fmt.Println("delete security IP success ", result)
11}参数管理
获取参数列表
使用以下代码可以获取Redis实例的配置参数和运行参数
Go
1result, err := client.GetParameters(instanceId)
2if err != nil {
3 fmt.Println("get parameter list failed:", err)
4} else ~~~~
5 fmt.Println("get parameter list success ", result)
6}修改参数
如下代码可以修改redis实例参数值
Go
1args := &scs.ModifyParametersArgs{
2 Parameter: InstanceParam{
3 Name: "parameter name",
4 Value: "new value",
5 },
6}
7result, err := client.ModifyParameters(instanceId, args)
8if err != nil {
9 fmt.Println("modify parameters failed:", err)
10} else
11 fmt.Println("modify parameters success ", result)
12}备份恢复
查看备份列表
使用以下代码可以查询某个实例备份列表
Go
1result, err := client.GetBackupList(instanceId)
2if err != nil {
3 fmt.Println("get backup list failed:", err)
4} else
5 fmt.Println("get backup list success ", result)
6}修改备份策略
如下代码可以修改redis实例自动备份策略
Go
1args := &scs.ModifyBackupPolicyArgs{
2 BackupDays: "Sun,Mon,Tue,Wed,Thu,Fri,Sta",
3 BackupTime: "01:05:00",
4 ExpireDay: 7,
5}
6result, err := client.ModifyBackupPolicy(instanceId, args)
7if err != nil {
8 fmt.Println("modify backup policy failed:", err)
9} else
10 fmt.Println("modify backup policy success ", result)
11}提示：
- BackupDays: 标识一周中哪几天进行备份备份周期：Mon（周一）Tue（周二）Wed（周三）Thu（周四）Fri（周五）Sat（周六）Sun（周日）逗号分隔，取值如：Sun,Wed,Thu,Fri,Sta
- BackupTime: 标识一天中何时进行备份，UTC时间（+8为北京时间）取值如：01:05:00
- ExpireDay: 备份文件过期时间，取值如：3