文档中心

云数据库 PostgreSQL 版

实例管理

CreateDBInstance

CreateDBInstance

调用 CreateDBInstance 接口创建实例。

请求类型

异步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
DBEngineVersion	String	是	PostgreSQL_12	兼容版本。取值： PostgreSQL_11：PostgreSQL 11。 PostgreSQL_12：PostgreSQL 12。 PostgreSQL_13：PostgreSQL 13。 PostgreSQL_14：PostgreSQL 14。 PostgreSQL_15：PostgreSQL 15。 PostgreSQL_16：PostgreSQL 16。 PostgreSQL_17：PostgreSQL 17。 PostgreSQL_18：PostgreSQL 18。说明若您需要开启 TDE 加密功能，仅支持选择 PostgreSQL 17。
NodeInfo	Array of NodeInfoObject	是	请参见请求示例。	实例规格配置。Primary 节点有且只有 1 个，Secondary 节点有且只有 1 个，Read-Only 节点可选 0~10 个。
StorageType	String	是	LocalSSD	实例存储类型。取固定值 LocalSSD（本地 SSD 盘）。
StorageSpace	Integer	否	100	实例的存储空间。说明不同规格对应的存储空间取值范围不同。关于存储空间取值范围的详细信息，请参见产品规格。单位为 GB，步长为 10 GB。
VpcId	String	是	vpc-2gdgzrrl5icjk50ztyz6b****	使用此参数指定实例使用的私有网络。说明如您使用 ECS 来连接 PostgreSQL 实例，则需使用和 ECS 实例相同的私有网络，否则 ECS 实例将无法通过私网连接到 PostgreSQL 实例。可调用 DescribeVpcs 接口查询可用的私有网络。可调用 CreateVpc接口创建新的私有网络。
SubnetId	String	是	subnet-30uhx4w39n75s7r2qr0lq****	子网 ID。说明仅支持选择实例所在可用区的子网。可以调用 DescribeSubnets 接口查询指定私有网络和可用区内的所有子网信息。可以调用 CreateSubnet接口创建新的子网。
AllowListIds	Array of String	否	[ "acl-fdd6293f300143f2a4932bb483c8**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	白名单 ID。如需绑定多个白名单，白名单 ID 用英文逗号（,）分隔。一个实例最多可绑定 100 个白名单。
InstanceName	String	否	Name123	实例名称，规则：不能以数字、中划线开头。只能包含中文、字母、数字、下划线和中划线。长度限制在 1~128 之间。
MaintenanceWindow	Object of MaintenanceWindowObject	否	请参见请求示例。	实例的可维时间段。
ProjectName	String	否	Test	所属项目，默认值为 default 项目。
Tags	Array of TagObject	否	[{ "Key": "test", "Value": "123" }]	标签数组对象。说明支持一次传入多组标签键值对象，多组标签键值对象间用英文逗号（,）分隔。单次最多同时传入 20 组标签键值对，单个实例最多绑定 50 个标签。
ChargeInfo	Object of ChargeInfoObject	是	{ "ChargeType": "PostPaid" }	付费方式。
TDEEnable	Boolean	否	true	是否开启 TDE 加密功能。取值： true：开启 TDE 加密功能。 false：关闭 TDE 加密功能（默认）。说明 TDE 加密功能目前在邀测中，如需使用，请提交工单申请。 TDE 加密功能开启后不支持关闭。
KMSTrn	String	否	trn:kms:cn-beijing:210xxxx:keyrings/testxxxx/keys/testxxxx	KMS 密钥环 TRN。格式为：trn:kms:<region>:<account_id>:keyrings/<ring_name>/keys/<key_name>。说明当 EnableTDE 为 true时，此参数必填。

NodeInfoObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	postgres-ca7b7019****	节点 ID。可调用 DescribeDBInstanceDetail 接口查询。说明在变更节点规格和删除节点（ModifyDBInstancesSpec）时必传。
ZoneId	String	是	cn-beijing-a	节点所在可用区，可调用 DescribeAvailabilityZones 查询。说明在创建实例（CreateDBInstance）、恢复到新实例（RestoreToNewInstance）、新增节点和修改节点（ModifyDBInstancesSpec）时必传。主节点、备节点和只读节点可部署在同一地域下的不同可用区。
NodeType	String	是	Primary	节点类型，取值为： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。
NodeSpec	String	是	rds.postgres.1c2g	节点规格。可通过 DescribeDBInstanceSpecs 接口查询可售卖的规格。
NodeOperateType	String	否	Create	操作类型。取值范围： Create：增加。 Delete：删除。 Modify：修改。说明在创建实例（CreateDBInstance）和恢复到新实例（RestoreToNewInstance）接口中，该字段取值只能为 Create。修改实例配置时，需为涉及的节点传入指定 NodeOperateType。

MaintenanceWindowObject

参数	类型	是否必选	示例值	描述
DayKind	String	是	Week	可维护周期的粒度，取值为 Week，周。
DayOfWeekMaintenanceTime	Array of DayOfWeekObject	否	请参见示例。	实例可维护时间段的详细信息。

DayOfWeekObject

参数	类型	是否必选	示例值	描述
DayOfWeek	String	是	Monday,Tuesday	指定实例在每周的可维护日。可多选。 Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。说明如果不指定该值或者为空，则默认一周七天都生效。
MaintenanceWindowStartTime	String	是	22:00Z	实例在可维护日的可维护时间段的起始时间。格式：HH:mmZ（UTC 时间）。说明当前仅支持将可维护时间段的起始时间设置在 16:00Z 至 20:00Z 之间。
Period	Integer	是	6	实例在可维护日的可维护时间段的时长。说明时长最小为 2 小时，最大时 6 小时。

TagObject

参数	类型	是否必选	示例值	描述
Key	String	是	abc	标签键。命名规则如下：不能以任何大小写形式的 volc: 开头。 volc: 为系统预留标签键，禁止使用。只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。长度限制在 1~128 个字符之间。说明单次创建的标签数量不能超过 20 个。单个实例下的标签键不能重复。
Value	String	否	3	标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。允许为空，长度限制在 0~256 个字符之间。

ChargeInfoObject

参数	类型	是否必选	示例值	描述
ChargeType	String	是	PostPaid	付费类型。取值： PostPaid：按量付费。 PrePaid：包年包月（默认）。
AutoRenew	Boolean	否	true	预付费场景下是否自动续费。 true：自动续费。 false：不自动续费（默认）。
PeriodUnit	String	否	Month	预付费场景下的购买周期。 Month：包月（默认）。 Year：包年。
Period	Integer	否	1	预付费场景下的购买时长。默认值：1。
Number	Integer	否	1	实例购买数量。可取 1~20 之间的整数值，默认值为 1。说明当 ChargeInfoObject 被 RestoreToNewInstance 接口引用时，Number 只允许设置为 1。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-21a3333b****	实例 ID。
OrderId	String	Order634971667632428****	订单 ID。

示例

请求示例

返回示例

最近更新时间：2026.10.16 14:22:31

这个页面对您有帮助吗？

有用

有用

无用

无用