文档中心

云数据库 PostgreSQL 版

实例管理

ModifyDBInstanceSpec

ModifyDBInstanceSpec

调用 ModifyDBInstanceSpec 接口修改实例配置。

请求类型

异步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
NodeInfo	Array of NodeInfoObject	否	请参见请求示例。	实例规格配置。Primary 节点有且只有 1 个，Secondary 节点有且只有 1 个，Read-Only 节点可选 0~10 个。说明该参数与 StorageSpace 二者必选其一，且这两个参数可同时修改。只需在该参数中传入变配涉及的节点。
ModifyType	String	否	Temporary	变配方式。取值为： Usually：常规变配，即立即变配。默认值。 Temporary：弹性升配，即临时升配。说明仅当实例的计费类型为包年包月实例时，支持为该参数取值为 Temporary。可通过调用 DescribeDBInstanceDetail接口查询实例的计费类型。
RollbackTime	String	否	2023-12-16T03:59:10.000Z	还原时间，时间格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明当 ModifyType 取值为 Temporary 时，该参数为必选。该参数仅在 ModifyType 取值为 Temporary 时生效。设置的还原时间的时间点与调用接口的时间点相差应不超过 2 分钟，实际的还原时间的时间点以调用接口的时间点为准。可多次发起临时升配延长临时升配期，但总时长不能超过 30 天（以第一次发起临时升配的时间为准）。可多次发起临时升配，但不允许缩短临时升配期。如实例已处于临时升配期：新的还原时间不能早于已生效的还原时间。距离包年包月实例的到期时间不足五天时，不允许再次发起临时升配。
StorageType	String	否	LocalSSD	实例存储类型。取固定值 LocalSSD（本地 SSD 盘）。说明该参数与 NodeInfo 二者必选其一，且这两个参数可同时修改。当 ModifyType 取值为 Temporary时，不支持设置该参数。
StorageSpace	Integer	否	100	实例的存储空间。单位为 GB，步长为 10 GB。说明不同规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。该参数与 NodeInfo 二者必选其一，且这两个参数可同时修改。当 ModifyType 取值为 Temporary时，不支持设置该参数。
SwitchType	String	否	Immediate	执行时间，取值： Immediate：立即切换（默认）。 MaintainTime：可维护时间段内进行切换。 SpecifiedTime：指定时间段内进行切换。说明可调用 DescribeDBInstanceDetail 接口查询实例的可维护时间段。取值为 SpecifiedTime时，需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。
SpecifiedSwitchStartTime	String	否	2024-12-25T14:00:00Z	指定时间段执行时时间段的起始时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ。
SpecifiedSwitchEndTime	String	否	2024-12-25T15:59:00Z	指定时间段执行时时间段的结束时间。时间格式为 yyyy-MM-ddTHH:mm:ssZ。说明 SwitchType 取值为 SpecifiedTime 时，该参数为必填参数。指定时间段的最短时长为一小时五十九分钟。
EstimateOnly	Boolean	否	true	是否发起变配评估。取值： true：是。 false：否。默认值。说明如果发起，则按照其他字段确定的规格配置进行变配评估，实际不会执行变配动作。发起变配评估后，会返回 EstimationResult 参数，说明此次变配的影响。

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。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-21a3333b****	实例 ID。
OrderId	String	Order725743560891294****	订单 ID。说明当 EstimateOnly 取值为 true时，该字段的返回值为空。
EstimationResult	Object of ModifyDBInstanceSpecEstimationResult	请参见返回示例。	按照当前配置变更后，预估会对实例产生的影响。说明当 EstimateOnly 取值为 false或不为 EstimateOnly 传值时，不返回该字段。

ModifyDBInstanceSpecEstimationResult

参数	类型	示例值	描述
Plans	Array of String	["AddNode", "RebuildPrimary"]	按照当前配置变更后，预估会对实例读写连接产生的影响。取值： AddNode：有增加节点。 DeleteNode：有删除节点。 RebuildPrimary：主库可能迁移。 RebuildReadOnly：只读可能迁移。 RebuildSecondary：备库可能迁移。
Effects	Array of String	["ReadWriteConnectionTransientError", "ReadOnlyConnectionTransientError" ]	按照当前配置变更后，预估会对实例读写连接产生的影响。取值： ReadOnlyConnectionTransientError：只读连接闪断。 ReadWriteConnectionTransientError：读写连接闪断。

示例

请求示例 1

常规变配

返回示例 1

请求示例 2

临时升配示例（升级主备节点规格）

返回示例 2

请求示例 3

变配影响预估

返回示例 3

最近更新时间：2026.03.31 10:39:11

这个页面对您有帮助吗？

有用

有用

无用

无用