本文介绍如何在 Redis 企业版中使用 Python 语言的 OpenAPI-SDK。

前提条件

已安装 Python 2.7 或以上版本。

SDK 下载地址

Redis Python SDK 源码地址，请参见 Redis Python SDK。

安装 SDK

您可以使用如下任意一种方式安装 SDK：

• 使用 pip 命令安装 SDK。

  pip install volcengine-python-sdk
  

• 下载 Redis Python SDK 源码并通过 Setuptools. 工具安装。您可以根据业务需要执行对应命令进行安装：

  • 执行如下命令为指定 user 安装 SDK。

    python setup.py install --<username>
    

  • 执行如下命令为全部 user 安装 SDK。

    sudo python setup.py install
    

请求超时时间设置

使用 Python SDK 调用 Redis 接口时，默认无超时时间限制。 您可以在发起接口调用请求时，在代码的最后加上 _request_timeout 参数来指定请求的超时时间（单位：秒），若未在该时间内完成，请求即会终止并报超时错误。

例如，您可以在调用 DescribeEnterpriseDBInstanceDetail 接口时，通过如下代码将超时时间设置为 10 秒。

resp = api_instance.describe_enterprise_db_instance_detail(volcenginesdkredis.DescribeEnterpriseDBInstanceDetail(
    instance_id="redis-cn04giei8c91*****",
), _request_timeout=10)

代码示例

Redis Python 客户端提供了一系列接口与 Redis 服务进行交互，用来管理 Redis 数据库资源。您需要先初始化 Redis Python 客户端，才可以向 Redis 服务发送 HTTP/HTTPS 请求。初始化客户端时，需要带上如下信息：

• 账号的 Access Key ID（简称 AK）和Secret Access Key（简称 SK）信息。获取 AKSK 信息的方法，请参见查看 AKSK 信息。

• Region 信息。Redis 支持的 Region，请参见服务地址。

创建 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))
        resp = api_instance.create_enterprise_db_instance(volcenginesdkredis.CreateEnterpriseDBInstanceRequest(
        # 设置需要创建实例的配置信息
        # 如下代码示例中仅使用了 CreateEnterpriseDBInstance 接口中的必填参数和部分选填参数
            region_id="cn-beijing",
            configure_nodes=[ volcenginesdkredis.ConfigureNodeForCreateEnterpriseDBInstanceInput(az = "cn-beijing-a") ],
            instance_name="python_sdk_shardedcluster_test",
            password="Pwd@12****",
            shard_number=2,
            ram_per_shard = 8192,
            flash_per_shard = 10240,
            vpc_id="vpc-1g0ckv3hu4s1s8ibuxwqe****",
            subnet_id="subnet-1g0ckvr67hfr48ibuxxgr****",
            charge_type = "PrePaid",
            purchase_months = 3,
            auto_renew = False,
        ))
        pprint(resp)
    except ApiException as e:
        print("Exception when calling REDISApi->create_enterprise_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))
        # 查询指定 Redis 企业版实例信息
        resp = api_instance.describe_enterprise_db_instance_detail(volcenginesdkredis.DescribeEnterpriseDBInstanceDetailRequest(
            instance_id="redis-cn04giei8c91*****",
        ))
        pprint(resp)
    except ApiException as e:
        print("Exception when calling REDISApi->describe_enterprise_db_instance_detail: %s\n" % e)