缓存数据库 Redis 版
缓存数据库 Redis 版
缓存数据库 Redis 版
文档指南
请输入
产品动态
用户指南
实例管理
网络连接管理
参数管理
性能分析
最佳实践
开发参考（控制面）
API 参考
实例管理
变更实例配置
备份恢复
参数管理
连接管理
账号管理
白名单管理
性能分析
任务中心
Terraform 参考
开发参考（数据面）
命令支持
常见问题
报错和异常
相关视频
- 文档首页
缓存数据库 Redis 版开发参考（控制面）SDK 参考Python SDK代码示例
复制全文
下载 pdf代码示例
文档反馈
问问助手本文介绍 Redis Python SDK 的代码示例供您参考。
前提条件
请求超时时间设置
使用 Python SDK 调用 Redis 接口时，默认无超时时间限制。
您可以在发起接口调用请求时，在代码的最后加上 _request_timeout 参数来指定请求的超时时间（单位：秒），若未在该时间内完成，请求即会终止并报超时错误。
例如，您可以在调用 DescribeDBInstanceDetail 接口时，通过如下代码将超时时间设置为 10 秒。
resp = api_instance.describe_db_instance_detail(volcenginesdkredis.DescribeDBInstanceDetailRequest(
instance_id="redis-cn04giei8c91*****",
), _request_timeout=10)
创建 Redis 实例
说明
示例 1
示例 2
使用如下示例代码创建 1 个启用分片集群的 Redis 实例，配置如下：
- 数据库版本号: 5.0。
- 可用内存：8 GiB（即 8192 MiB）。
- 分片数：2。
- 每个分片中的节点数：3。
- 在华北 2（北京）地域下使用多可用区部署，其中主节点部署在可用区 A，2 个从节点均在可用区 B。
- 绑定至 acl-cq014ioqkm9zt5j**** 和 acl-cq015pp15v8buvl**** 两个白名单。
- 绑定 department:game 和 owner:Alice 两个标签。
- 计费类型：包年包月，预计使用 3 个月，且不开启自动续费。
import volcenginesdkredis
import volcenginesdkcore
from volcenginesdkcore.rest import ApiException
from pprint import pprint
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
try:
api_instance = volcenginesdkredis.REDISApi(volcenginesdkcore.ApiClient(configuration))
resp = api_instance.create_db_instance(volcenginesdkredis.CreateDBInstanceRequest(
region_id="cn-beijing",
multi_az="enabled",
configure_nodes=[
volcenginesdkredis.ConfigureNodeForCreateDBInstanceInput(az="cn-beijing-a"),
volcenginesdkredis.ConfigureNodeForCreateDBInstanceInput(az="cn-beijing-b"),
volcenginesdkredis.ConfigureNodeForCreateDBInstanceInput(az="cn-beijing-c"),
],
instance_name="python_sdk_shardedcluster_test",
sharded_cluster=1,
password="Pwd@12****",
node_number=2,
shard_number=2,
shard_capacity=8192,
engine_version="5.0",
vpc_id="vpc-1g0ckv3hu4s1s8ibuxwqe****",
subnet_id="subnet-1g0ckvr67hfr48ibuxxgr****",
))
pprint(resp)
except ApiException as e:
print("Exception when calling REDISApi->create_db_instance: %s\n" % e)
使用如下示例代码创建 1 个未启用分片集群的 Redis 实例，配置如下：
- 数据库版本号: 5.0。
- 可用内存：8 GiB（即 8192 MiB）。
- 节点数：2。
- 在华北 2（北京）地域下使用单可用区部署，且所有节点部署在可用区 A。
import volcenginesdkredis
import volcenginesdkcore
from volcenginesdkcore.rest import ApiException
from pprint import pprint
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
try:
api_instance = volcenginesdkredis.REDISApi(volcenginesdkcore.ApiClient(configuration))
resp = api_instance.create_db_instance(volcenginesdkredis.CreateDBInstanceRequest(
region_id="cn-beijing",
multi_az="disabled",
configure_nodes=[
volcenginesdkredis.ConfigureNodeForCreateDBInstanceInput(az="cn-beijing-a"),
],
instance_name="python_sdk_test",
sharded_cluster=0,
password="Pwd@12****",
node_number=2,
shard_capacity=8192,
engine_version="5.0",
vpc_id="vpc-1g0ckv3hu4s1s8ibuxwqe****",
subnet_id="subnet-1g0ckvr67hfr48ibuxxgr****",
))
pprint(resp)
except ApiException as e:
print("Exception when calling REDISApi->create_db_instance: %s\n" % e)
查询 Redis 实例信息
说明
import volcenginesdkredis
import volcenginesdkcore
from volcenginesdkcore.rest import ApiException
from pprint import pprint
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
try:
api_instance = volcenginesdkredis.REDISApi(volcenginesdkcore.ApiClient(configuration))
# Querying information about specified Redis instance
resp = api_instance.describe_db_instance_detail(volcenginesdkredis.DescribeDBInstanceDetailRequest(
instance_id="redis-cn04giei8c91*****",
))
pprint(resp)
except ApiException as e:
print("Exception when calling REDISApi->describe_db_instance_detail: %s\n" % e)
最近更新时间：2026.02.27 17:24:35
这个页面对您有帮助吗？
有用
有用
无用
无用