Call the ModifyDBProxySpec API to modify the proxy configuration of an instance.

Request type

Asynchronous request.

Precautions

Database proxy configurations cannot be modified for overdue or recovering instances.

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.

Request parameters

Parameter	Type	Is it required?	Sample value	Description
InstanceId	String	Yes	mysql-cf4f3ddc****	Instance ID.
ProxyNodeCustom	Object of ProxyNodeCustomObject	Yes	See the request example.	The specification of the database proxy service for the instance.
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.
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.

ProxyNodeCustomObject

Parameter	Type	Is it required?	Sample value	Description
CpuNum	Integer	No	4	The number of CPU cores for the database proxy service of the instance. Values are as follows: Value range: Upper limit 1024. For a multiple-node instance, The recommended number of proxy cores is the total number of CPUs of all serviceable nodes of the instance * 0.25 (round up the result). The minimum number of proxy cores is the greater of 2 and the number of CPU cores of the primary node * 0.125. For a double-node instance, The recommended number of proxy cores is the total number of CPUs of all serviceable nodes of the instance * 0.5 (round up the result). The minimum number of proxy cores is the greater of 2 and the number of CPU cores of the primary node * 0.5.

Response parameters

Parameter	Type	Sample value	Description
OrderId	String	(Null)	The configuration order number.

Sample

Sample request

Sample response

Error code

For more details, refer to Error codes.