云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
云数据库 PostgreSQL 版
文档指南
请输入
产品动态
用户指南
实例管理
连接管理
服务可用性
Schema 管理
备份恢复
日志管理
数据安全
插件
API 参考
V2（2022-01-01）
实例管理
账号管理
连接管理
参数管理
备份与恢复
数据安全
SDK 参考
V2（2022-01-01）
相关协议
- 文档首页
云数据库 PostgreSQL 版SDK 参考V2（2022-01-01）使用 Python SDK
复制全文
下载 pdf使用 Python SDK
文档反馈
问问助手本文介绍云数据库 PostgreSQL 版 Python SDK 的下载、安装与初始化客户端的相关信息。
下载与安装
前提条件
已安装 Python 2.7 或以上版本。
说明
您可以执行 python --version 命令检查当前 Python 的版本。
SDK 下载地址
安装 SDK
您可以使用以下任意一种方式安装 SDK：
- 执行如下命令为指定 user 安装 SDK。
- python setup.py install --<username>
- 执行如下命令为全部 user 安装 SDK。
- sudo python setup.py install
说明
如果已经安装过 SDK，可使用如下命令升级。
pip install --upgrade volcengine
初始化客户端
PostgreSQL Python 客户端提供了一系列接口与 PostgreSQL 服务进行交互，用来管理 PostgreSQL 数据库资源。您需要先初始化 PostgreSQL Python 客户端，才可以向 PostgreSQL 服务发送 HTTP/HTTPS 请求。
前提条件
- 已获取账号的 Access Key ID（简称 AK）和 Secret Access Key（简称 SK）信息。具体操作，请参见 Access Key 管理。
- 已获取云数据库 PostgreSQL 版支持的 Region 和对应的 Host，请参见服务地址。
- 已下载并安装云数据库 PostgreSQL 版 Python SDK。具体操作步骤，请参见下载与安装。
初始化客户端
使用如下代码初始化客户端。
import volcenginesdkcore
import volcenginesdkrdspostgresql as pg
from volcenginesdkcore.rest import ApiException
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
# 设置 AKSK 验证信息及 Region
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
configuration.host = "Your Host"
try:
# 创建 PostgreSQL SDK 客户端，接口调用均需要通过此客户端执行
api_instance = pg.RDSPOSTGRESQLApi(volcenginesdkcore.ApiClient(configuration))
except ApiException as e:
print("Exception: %s\n" % e)
代码示例
请求超时时间设置
使用 SDK 调用 PostgreSQL 接口时，默认无超时时间限制。您可以在发起接口调用请求时，在代码的最后加上 _request_timeout 参数指定请求的超时时间（单位：秒），若未在该时间内完成，请求会立即终止并报超时错误。例如，您可以在调用 DescribeDBInstances 接口时，通过以下代码设置超时时间为 10 秒。
resp = api_instance.describe_db_instances(pg.DescribeDBInstancesRequest(
page_number=1,
page_size=10,
), _request_timeout=10)
创建 PostgreSQL 实例
from pprint import pprint
import volcenginesdkcore
import volcenginesdkrdspostgresql as pg
from volcenginesdkcore.rest import ApiException
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
configuration.host = "Your Host"
try:
api_instance = pg.RDSPOSTGRESQLApi(volcenginesdkcore.ApiClient(configuration))
resp = api_instance.create_db_instance(pg.CreateDBInstanceRequest(
db_engine_version="PostgreSQL_12",
node_info=[
pg.NodeInfoForCreateDBInstanceInput(
zone_id="cn-beijing-a",
node_type="Primary",
node_spec="rds.postgres.1c2g",
node_operate_type="Create"
),
pg.NodeInfoForCreateDBInstanceInput(
zone_id="cn-beijing-a",
node_type="Secondary",
node_spec="rds.postgres.1c2g",
node_operate_type="Create"
),
],
storage_type="LocalSSD",
storage_space=20,
vpc_id="vpc-2bzo8w6m87v282dx0eemg****",
subnet_id="subnet-2d6b6byrhtts058ozfenq****",
charge_info=pg.ChargeInfoForCreateDBInstanceInput(charge_type="PostPaid"),
instance_name="testname",
))
pprint(resp)
except ApiException as e:
print("Exception: %s\n" % e)
本示例中参数配置如下表所示。
配置项 | 说明 | 取值 |
配置项 | 说明 | 取值 |
DBEngineVersion | 实例版本。 | PostgreSQL_12 |
NodeInfo | 实例规格配置。 | [{ "ZoneId": "cn-beijing-a", "NodeSpec": "rds.postgres.1c2g", "NodeType": "Primary", "NodeOperateType": "Create" }, { "ZoneId": "cn-beijing-a", "NodeSpec": "rds.postgres.1c2g", "NodeType": "Secondary", "NodeOperateType": "Create" }] |
StorageType | 实例存储类型。 | LocalSSD |
StorageSpace | 实例存储空间。 | 20 |
VpcId | 专有网络（VPC） ID。 | vpc-2bzo8w6m87v282dx0eemg**** |
SubnetId | 子网 ID。 | subnet-2d6b6byrhtts058ozfenq**** |
InstanceName | 实例名称。 | testname |
ChargeInfo | 计费类型。 | { "ChargeType": "PostPaid" } |
查询 PostgreSQL 实例信息
from pprint import pprint
import volcenginesdkcore
import volcenginesdkrdspostgresql as pg
from volcenginesdkcore.rest import ApiException
if __name__ == "__main__":
configuration = volcenginesdkcore.Configuration()
configuration.ak = "Your AK"
configuration.sk = "Your SK"
configuration.region = "Your Region"
configuration.host = "Your Host"
try:
# 创建 PostgreSQL SDK 客户端，接口调用均需要通过此客户端执行
api_instance = pg.RDSPOSTGRESQLApi(volcenginesdkcore.ApiClient(configuration))
resp = api_instance.describe_db_instance_detail(pg.DescribeDBInstanceDetailRequest(
instance_id="Your InstanceId",
))
print(resp)
except ApiException as e:
print("Exception: %s\n" % e)
最近更新时间：2026.01.05 17:36:10
这个页面对您有帮助吗？
有用
有用
无用
无用