文档中心

云数据库 MySQL 版

实例管理

ModifyDBNodeSpec - 变更实例的节点规格

ModifyDBNodeSpec - 变更实例的节点规格

调用 ModifyDBNodeSpec 接口变更实例的节点规格。

请求类型

异步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-db6d920e****	实例 ID。
StorageType	String	是	LocalSSD	实例的存储类型。取值范围： LocalSSD：本地盘。 CloudESSD_FlexPL：FlexPL 云盘。 CloudESSD_PL0：PL0 云盘。 CloudESSD_HighPerf：高性能云盘。说明如需设定 StorageSpace 参数，StorageType 参数为必传。当 InstanceType 取值为 SingleNode 时，StorageType 取值只能为 CloudESSD_FlexPL、CloudESSD_PL0 或 CloudESSD_HighPerf。在不同接口中，该参数取值范围不同。具体规则如下：在以下接口中作为请求参数时，StorageType 的取值只能为 LocalSSD。 RestoreToCrossRegionInstance RestoreToNewInstanceFromUserTos 在部分接口中作为请求参数时，该参数的取值范围与原实例的存储类型有关，具体规则如下：原实例的存储类型为 LocalSSD时，不支持变更存储类型。原实例的存储类型为 CloudESSD_PL0 时，可取值为 CloudESSD_PL0、 CloudESSD_FlexPL 或 CloudESSD_HighPerf。涉及的接口是： RebuildDBInstance RestoreToNewInstance ModifyDBNodeSpec
StorageSpace	Integer	否	100	实例存储空间。每个规格对应的存储空间取值范围不同，关于存储空间取值范围的详细信息，请参见产品规格。单位为 GiB，步长 10 GiB。说明不填写该参数时，则默认保持原存储空间大小。
NodeInfo	Array of NodeInfoObject	否	请参见请求示例。	实例的节点变配信息。
SwitchType	String	否	MaintainTime	执行时间，取值： Immediate：立即切换（默认）。 MaintainTime：可维护时间段内进行切换。 SpecifiedTime：指定时间段内进行切换。说明可调用 DescribeDBInstanceDetail 接口查询实例的可维护时间段。取值为 SpecifiedTime时，需要在参数 SpecifiedSwitchStartTime 和 SpecifiedSwitchEndTime 中设定时间段的起止时间。
RequestSource	String	否	EventType_Web	请求来源。取值： EventType_Web：来自 Web。 EventType_OpenAPI：来自 Open API。
EstimateOnly	Boolean	否	true	是否发起变配评估。取值： true：是。 false：否。默认值。说明如果发起，则按照其他字段确定的规格配置进行变配评估，实际不会执行变配动作。发起变配评估后，会返回 EstimationResult 参数，说明此次变配的影响。
SpecifiedSwitchStartTime	String	否	2024-12-25T14:00:00Z	指定时间段执行时，时间段的起始时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。说明 SwitchType 取值为 SpecifiedTime 时，该参数为必填参数。任务执行的起始时间不得晚于当前日期后的第 7 日。
SpecifiedSwitchEndTime	String	否	2024-12-25T15:59:00Z	指定时间段执行时，时间段的结束时间（UTC 时间）。格式为 yyyy-MM-ddTHH:mm:ssZ。说明 SwitchType 取值为 SpecifiedTime 时，该参数为必填参数。指定时间段的最短时长为一小时五十九分钟。不支持跨天设置时间段，即任务执行的起始时间和结束时间不超过 24 小时。

NodeInfoObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	mysql-050b3e08****-r6e25	节点 ID。说明创建实例或新增节点时无需传入该参数，变更节点配置或删除节点时必传。
NodeType	String	是	Primary	节点类型，取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。说明在查询实例价格详情接口（DescribeDBInstancePriceDetail）中，该字段为可选。在增加节点（CreateDBNodes）时，该字段取值只能为 ReadOnly（双节点实例）或 Secondary（多节点实例）。对于双节点实例，主节点和备节点有且只有 1 个，只读节点可选 0~10 个。对于多节点实例，主节点有且只有 1 个，最多可添加 8 个备节点，最少需有 1 个备节点。建议预留一个不承载业务的独立备节点，以便在必要时将其切换为主节点。若因未设置独立备节点致使所有备节点主备延迟过高，进而导致主节点切换失败，云数据库 MySQL 版不承担相关责任。
NodeSpec	String	是	rds.mysql.1c2g	节点规格。关于节点规格的详细信息，请参见产品规格。说明备节点的规格需与主节点的规格保持一致。只读节点规格可低于主节点的规格。但需注意，当只读节点规格低于主节点规格时，可能会因为主节点负载过高导致只读节点存在延迟甚至只读节点 OOM。建议为只读节点选择采与主节点相同或更高的规格。如 StorageType 取值为 CloudESSD_FlexPL 或 CloudESSD_PL0，NodeSpec 只能传入通用规格。
ZoneId	String	是	cn-beijing-a	节点所在可用区，可调用 DescribeAvailabilityZones 接口查询。在创建实例和新增节点时必传，变更节点配置或删除节点时可不传。说明一个实例的节点最多可分布在三个可用区。在一次变配中，最多可增删三个可用区下的节点。
NodeOperateType	String	否	Modify	操作类型。创建实例时无需传入该参数，修改节点配置时需要传入。取值范围： Create：增加节点。 Modify：修改节点配置。说明在增加节点（CreateDBNodes）时，该字段只能取值为 Create。在变更配置时，该字段只能取值为Modify。填写为 Delete时，该取值无实际意义。

返回参数

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

ModifyDBInstanceSpecEstimationResult

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

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.10.23 17:52:44

这个页面对您有帮助吗？

有用

有用

无用

无用