You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

Copy page
Download PDF
Security encryption
ModifyDBInstanceSSL
Copy page
Download PDF
ModifyDBInstanceSSL
Call the ModifyDBInstanceSSL API to modify the SSL configuration of a specified MySQL instance.​
Request type​
Synchronous request.​
Precautions​
  • MySQL 8.4 instances do not support TDE data encryption.​
  • Modifying the SSL configuration of the instance requires restarting the instance.​
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-d4942fd7****​
Instance ID.​
SSLEnable​
Boolean​
No​
true​
Enable or disable SSL encryption. The valid values are:​
  • true: enabled.​
  • false: disable (Default value).​
tip​
If this field is not set, the SSL encryption status of the instance is not changed.​
ReloadSSLCertificate​
Boolean​
No​
true​
Update the SSL certificate validity period. A value of true updates the SSL certificate validity period.​
tip​
  • This parameter takes effect only when SSL encryption is enabled for the instance.​
  • Cannot be modified at the same time as the SSLEnable field.​
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​
  • 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.​
  • Must be on the hour.​
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.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=ModifyDBInstanceSSL&Version=2022-01-01 HTTP/1.1​
Accept: application/json​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-d4942fd7****",​
"SSLEnable": false​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "2023081011522556C5C8F6ECB0DFF517D4",​
"Action": "ModifyDBInstanceSSL",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-beijing"​
},​
"Result": {}​
}​
​
Error code​
For more details, refer to Error codes.​
Last updated: 2026.06.12 17:17:52