主要接口

更新时间：2024-05-14

云数据库 Redis（Simple Cache Service）提供稳定、高效以及高可扩展性的分布式缓存服务。云数据库 Redis 兼容 Redis/Memcached 协议，基于 Redis 提供标准版和集群版的架构模式，并支持自定义副本数量，为您提供多样化的数据结构支持。

订单服务

创建实例

使用以下代码可以创建Redis实例，用于创建一个或多个redis实例

args := &scs.CreateInstanceArgs{
    // 选择付款方式，可以选择预付费或后付费 
    Billing: api.Billing{
        PaymentTiming: api.PaymentTimingPostPaid,
    },
    // 购买个数，最大不超过10，默认1
	PurchaseCount: 1,
    // 实例名
    // 要求：1）支持大小写字母、数字以及-_ /.等特殊字符，必须以字母开头；2）长度限制为1-64；
	InstanceName:  "sdk-scs",
    // 端口号 1025<port<22222，22222<port<65535
	Port:          6379,
    // 引擎版本，集群：3.2、4.0、5.0 主从：2.8、3.2、4.0、5.0
	EngineVersion: "3.2",
    // 节点规格
	NodeType:      "cache.n1.micro",
    // 集群类型，集群版："cluster"，主从版："master_slave"
	ClusterType:   "master_slave",
    // 副本个数，单副本为1，双副本为2，多副本依此类推
	ReplicationNum:  1,
    // 分片个数
	ShardNum:      1,
    // 代理节点数，主从版：0，集群版：代理节点数=分片个数
	ProxyNum:      0,
}

// 若要生成预付费实例，可以按以下配置生成一个月的预付费实例
args.Billing = api.Billing{
		PaymentTiming: api.PaymentTimingPrePaid,
		Reservation: &api.Reservation{
            ReservationLength:   1,
            ReservationTimeUnit: "month",
        }
	}

// 若要设置自动续费，可以按以下参数设置一年内自动续费
// 按月付费或者按年付费 月是"month"，年是"year"
// 自动续费的时间 按月是1-9 按年是 1-3
args.AutoRenewTimeUnit = "year"
args.AutoRenewTime = 1

result, err := client.CreateInstance(args)
if err != nil {
    fmt.Println("create instance failed:", err)
} else {
    fmt.Println("create instance success: ", result)
}

提示：

创建Redis请求是一个异步请求，返回200表明订单生成，后续可以通过实例id查询实例创建进度。

本接口用于创建一个或多个同配置Redis实例。

创建实例需要实名认证，没有通过实名认证的可以前往百度开放云官网控制台中的安全认证下的实名认证中进行认证。

创建计费方式为后付费的实例需要账户现金余额+通用代金券大于100；预付费方式的实例则需要账户现金余额大于等于实例费用。

支支持批量创建，且如果创建过程中有一个实例创建失败，所有实例将全部回滚。

创建请求详细使用请参考Redis API 文档创建实例

创建Redis需要使用指定规格, 详细请参考Redis API 文档实例规格

变更配置

args := &scs.ResizeInstanceArgs{
		NodeType:"cache.n1.small",
		ShardNum:2,
}
err := client.ResizeInstance(instanceId, args)
if err != nil {
    fmt.Println("resize instance failed:", err)
} else {
    fmt.Println("resize instance success")

提示：

实例计费方式为预付费时，不能进行缩容操作

实例计费方式为后付费时，可弹性扩缩容

只有实例正常运行状态时才可以进行扩缩容操作，变更接口为异步变更，可通过查询指定实例详情接口查询实例状态

释放实例

如下代码可以释放实例,实例将自动进入回收站，保留7天后删除

err := client.DeleteInstance(instanceId)
if err != nil {
    fmt.Println("delete instance failed:", err)
} else {
    fmt.Println("delete instance success")
}

提示：

释放单个Redis实例，释放后实例将进入回收站，保留7天后自动删除所有物理资源。

可以从回收站内恢复实例或者彻底删除实例,预付费实例需要通过续费实例接口进行恢复。

实例服务

查询实例列表

以下代码可以查询Redis实例列表

args := &scs.ListInstancesArgs{}

result, err := client.ListInstances(args)
if err != nil {
    fmt.Println("list instance failed:", err)
} else {
    fmt.Println("list instance success: ", result)
}

查询指定实例详情

使用以下代码可以查询指定Redis虚机的详细信息

result, err := client.GetInstanceDetail(instanceId)
if err != nil {
    fmt.Println("get instance detail failed:", err)
} else 
    fmt.Println("get instance detail success ", result)
}

修改实例名称

如下代码可以修改实例名称

args := &scs.UpdateInstanceNameArgs{
    InstanceName: "newInstanceName",
}
err := client.UpdateInstanceName(instanceId, args)
if err != nil {
    fmt.Println("update instance name failed:", err)
} else {
    fmt.Println("update instance name success")
}

提示：

只有实例Running状态时可以修改实例名称

查询实例套餐规格

如下代码可以查询当前可以创建的实例的套餐的规格

result, err := client.GetNodeTypeList()
if err != nil { 
    fmt.Println("list node type failed: ", err)
} else {
    fmt.Println("list node type success: ", result)
}

获取子网列表

如下代码可以获取子网列表

args := &scs.ListSubnetsArgs{}
_, err := client.ListSubnets(args)
if err != nil {
    fmt.Println("get subnet list failed:", err)
} else {
    fmt.Println("get subnet list success")
}

提示：

请求参数 vpcId 和 zoneName 不是必须的

修改实例域名

如下代码可以修改实例域名

args := &scs.UpdateInstanceDomainNameArgs{
    Domain:  "newDomainName",
}
err := client.UpdateInstanceDomainName(instanceId, args)
if err != nil {
    fmt.Println("update instance domain name failed:", err)
} else {
    fmt.Println("update instance domain name success")
}

提示：

只有实例Running状态时可以修改实例域名

获取可用区列表

使用以下代码可以获取可用区列表

result, err := client.GetZoneList()
if err != nil {
    fmt.Println("get zone list failed:", err)
} else 
    fmt.Println("get zone list success ", result)
}

清空实例

如下代码可以清空实例

args := &scs.FlushInstanceArgs{
    Password:  "Password",
}
result, err := client.FlushInstance(instanceId, args)
if err != nil {
    fmt.Println("flush instance failed:", err)
} else 
    fmt.Println("flush instance success ", result)
}

提示：

对redis实例，清空后表现为数据占用内存下降，数据被清空；对memcache实例，清空后表现为占用内存不会下降，但是数据被清空

如果没有设置密码，传递空字符串

绑定标签

如下代码可以绑定标签

args := &scs.BindingTagArgs{
    ChangeTags:  []model.TagModel{
				{
					TagKey:   "tag1",	
					TagValue: "var1",
				},
	},
}
result, err := client.BindingTag(instanceId, args)
if err != nil {
    fmt.Println("bind tags failed:", err)
} else 
    fmt.Println("bind tags success ", result)
}

解绑标签

如下代码可以解绑标签

args := &scs.BindingTagArgs{
    ChangeTags:  []model.TagModel{
				{
					TagKey:   "tag1",	
					TagValue: "var1",
				},
	},
}
result, err := client.UnBindingTag(instanceId, args)
if err != nil {
    fmt.Println("unbind tags failed:", err)
} else 
    fmt.Println("unbind tags success ", result)
}

提示：

解绑实例上定义的标签

可以同时解绑多个标签

网络安全

修改访问密码

如下代码可以修改访问密码

args := &scs.ModifyPasswordArgs{
    Password:  "newPassword",
}
result, err := client.ModifyPassword(instanceId, args)
if err != nil {
    fmt.Println("modify password failed:", err)
} else 
    fmt.Println("modify password success ", result)
}

提示：

密码长度8～16位，至少包含字母、数字和特殊字符中两种。允许的特殊字符包括 $^*()_+-=

查询IP白名单

如下代码可以查询允许访问实例的IP白名单

result, err := client.GetSecurityIp(instanceId)
if err != nil {
    fmt.Println("get security IP failed:", err)
} else 
    fmt.Println("get security IP success ", result)
}

提示：

返回参数 IP白名单列表, 包括常规地址: 如192.168.0.1，CIDR地址: 如192.168.1.0/24，0.0.0.0/0代表允许所有地址

增加IP白名单

如下代码可以增加访问实例的IP白名单

args := &scs.SecurityIpArgs{
    SecurityIps:  []string{
					"192.0.0.1",
				},	
}
result, err := client.AddSecurityIp(instanceId, args)
if err != nil {
    fmt.Println("add security IP failed:", err)
} else 
    fmt.Println("add security IP success ", result)
}

删除IP白名单

如下代码可以删除访问实例的IP白名单

args := &scs.SecurityIpArgs{
    SecurityIps:  []string{
					"192.0.0.1",
				},	
}
result, err := client.DeleteSecurityIp(instanceId, args)
if err != nil {
    fmt.Println("delete security IP failed:", err)
} else 
    fmt.Println("delete security IP success ", result)
}

参数管理

获取参数列表

使用以下代码可以获取Redis实例的配置参数和运行参数

result, err := client.GetParameters(instanceId)
if err != nil {
    fmt.Println("get parameter list failed:", err)
} else ~~~~
    fmt.Println("get parameter list success ", result)
}

修改参数

如下代码可以修改redis实例参数值

args := &scs.ModifyParametersArgs{
				Parameter: InstanceParam{
					Name: "parameter name",
					Value: "new value",
				},
}
result, err := client.ModifyParameters(instanceId, args)
if err != nil {
    fmt.Println("modify parameters failed:", err)
} else 
    fmt.Println("modify parameters success ", result)
}

备份恢复

查看备份列表

使用以下代码可以查询某个实例备份列表

result, err := client.GetBackupList(instanceId)
if err != nil {
    fmt.Println("get backup list failed:", err)
} else 
    fmt.Println("get backup list success ", result)
}

修改备份策略

如下代码可以修改redis实例自动备份策略

args := &scs.ModifyBackupPolicyArgs{
				BackupDays: "Sun,Mon,Tue,Wed,Thu,Fri,Sta",
				BackupTime: "01:05:00",
				ExpireDay: 7,
}
result, err := client.ModifyBackupPolicy(instanceId, args)
if err != nil {
    fmt.Println("modify backup policy failed:", err)
} else 
    fmt.Println("modify backup policy success ", result)
}

提示：

BackupDays: 标识一周中哪几天进行备份备份周期：Mon（周一）Tue（周二）Wed（周三）Thu（周四）Fri（周五）Sat（周六）Sun（周日）逗号分隔，取值如：Sun,Wed,Thu,Fri,Sta

BackupTime: 标识一天中何时进行备份，UTC时间（+8为北京时间）取值如：01:05:00

ExpireDay: 备份文件过期时间，取值如：3

初始化

异常处理