Call the ModifyDBNodeTemporarySpec API to temporarily upgrade the configuration of an instance.

Request type

Asynchronous request.

Precautions

The temporary upgrade is currently an allowlisted feature. While there are a few minor areas for experience optimization, they do not affect the normal operation of the instance. If your business has specific needs for this feature, submit a ticket to apply for allowlist access.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Is it required?	Sample value	Description
InstanceId	String	Yes	mysql-db6d920e****	Instance ID.
NodeInfo	Array of NodeInfoObject	Yes	See the request example.	The node configuration change information of the instance.
RollbackTime	String	Yes	2024-10-16T03:59:10.000Z	Restoration time of temporary upgrade. The restoration time can be set to any time between 5 and 30 days after the current time. Time format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
SwitchType	String	No	MaintainTime	Execution time. The valid values are: Immediate: switch now (default). MaintainTime: switch during the maintenance window. SpecifiedTime: switch during the specified time period. tip You can call the DescribeDBInstanceDetail API to query the instance's maintenance window. When the value is SpecifiedTime, you must set the start and end time of the time period in the SpecifiedSwitchStartTime and SpecifiedSwitchEndTime parameters.
RequestSource	String	No	EventType_Web	The source of the request. Values: EventType_Web: from the Web. EventType_OpenAPI: From Open API.
EstimateOnly	Boolean	No	true	Specifies whether to initiate an assessment for the specification change. Values: true: yes. false: no. Default value. tip If this parameter is specified, the system evaluates the specification change based on the parameters set for other fields without performing the actual change. After you initiate the evaluation, the system returns the EstimationResult parameter, which describes the impact of the specification change.
SpecifiedSwitchStartTime	String	No	2024-12-25T14:00:00Z	The start time of the specific time period for execution(UTC time). The format is yyyy-MM-ddTHH:mm:ssZ. tip When SwitchType is set to SpecifiedTime, this parameter is required. The start time of the task cannot be later than seven days after the current date.
SpecifiedSwitchEndTime	String	No	2024-12-25T15:59:00Z	The end time of the specific time period for execution (UTC time). The format is yyyy-MM-ddTHH:mm:ssZ. tip This parameter is required when the value of SwitchType is SpecifiedTime. The minimum time period is one hour and fifty-nine minutes. Time periods cannot be set across days. The task's start and end times must be within a 24-hour window.

NodeInfoObject

Parameter	Type	Is it required?	Sample value	Description
NodeId	String	No	mysql-050b3e08****-r6e25	Node ID. tip This parameter is not required when you create an instance or add a node, but is required when you modify the node configuration or delete a node.
NodeType	String	Yes	Primary	Node type, with values: Primary: primary node. Secondary: secondary node. ReadOnly: read-only node. tip This parameter is optional for the DescribeDBInstancePriceDetail API. When you add a node by calling the CreateDBNodes API, you can set this parameter only to ReadOnly for a double-node instance or Secondary for a multiple-node instance. A double-node instance consists of one primary node, one secondary node, and 0 to 10 optional read-only nodes. A multiple-node instance consists of one primary node, and at least one and up to eight secondary nodes. We recommend that you reserve an independent secondary node that does not handle workloads. This allows you to switch it to the primary node when necessary. RDS for MySQL assumes no responsibility for any risks or losses incurred due to the failure to configure independent secondary nodes or the inability to complete the primary node switching due to excessive latency of all secondary nodes.
NodeSpec	String	Yes	rds.mysql.1c2g	Node specification. For details on node specification, refer to Product specification. tip The specification of the secondary node must be the same as that of the primary node. The read-only node specification can be lower than the primary node specification. However, when the read-only node specification is lower than the primary node specification, the read-only node may be delayed or even experience an OOM error due to the high load on the primary node. It is recommended that the read-only node be selected with the same or higher specification as the primary node. If StorageType is set to CloudESSD_FlexPL or CloudESSD_PL0, only the general type can be passed for NodeSpec.
ZoneId	String	Yes	cn-beijing-a	The availability zone where the node is located. You can call the DescribeAvailabilityZones API to query it. Required when creating an instance or adding a node. Optional when changing node configuration or deleting a node. tip The nodes of an instance can be distributed across a maximum of three availability zones. During a single configuration change, you can add or delete nodes in up to three availability zones.
NodeOperateType	String	No	Modify	Operation type. This parameter is not required when you create an instance but is required when you modify the node configuration. Range: Create: add. Modify: modify. tip When adding a node (CreateDBNodes), this field can only be Create. When you modify the configuration, this parameter can only be set to Modify. This value has no actual meaning when set to Delete.

Response parameters

Parameter	Type	Sample value	Description
InstanceId	String	mysql-db6d920e****	Instance ID.
OrderId	String	Order71220115095297****	Order ID. tip When EstimateOnly is true, this field is empty.
EstimationResult	Object of ModifyDBInstanceSpecEstimationResult	Refer to the Sample response.	Estimated impact on the instance after changing the current configuration. tip This field is not returned if the EstimateOnly parameter is set to false or is not specified.

ModifyDBInstanceSpecEstimationResult

Parameter	Type	Sample value	Description
Plans	Array of String	[ "AddNode" ]	Estimated impact on the instance after changing the current configuration. Values: AddNode: new node(s) will be added. DeleteNode: there are nodes to be deleted. RebuildPrimary: the primary database may be migrated. RebuildReadOnly: the read-only node may be migrated. RebuildSecondary: the secondary database may be migrated.
Effects	Array of String	[ "ReadWriteConnectionTransientError", "ReadOnlyConnectionTransientError" ]	The estimated impact on the read/write connection of the instance after the configuration change. Values: ReadOnlyConnectionTransientError: read-only connection transient disconnection. ReadWriteConnectionTransientError: read-write connection transient disconnection.

Sample

Sample request

Sample response

Error code

For more details, refer to Error codes.

RDS for MySQL