Configuring SSL
Function
This API is used to configure SSL to encrypt connections.
- Before calling this API, learn how to authenticate it.
- Before calling this API, learn about request header parameters.
Constraints
SSL cannot be configured when a DB instance is being created, rebooted, or upgraded, its specifications are being modified, or database users are being created or deleted.
This API is supported only for RDS for MySQL instances.
URI
- Parameter description
Table 1 Parameters Parameter
Mandatory
Description
project_id
Yes
Definition
Project ID of a tenant in a region.
To obtain the value, see Obtaining a Project ID.
Constraints
N/A
Range
N/A
Default Value
N/A
instance_id
Yes
Definition
Instance ID.
Constraints
N/A
Range
N/A
Default Value
N/A
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ssl_option |
Yes |
boolean |
Definition Specifies whether to enable SSL. Constraints N/A Range
Default Value N/A |
Example Request
- Enable SSL for a DB instance.
PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl { "ssl_option": true }
- Disable SSL for a DB instance.
{ "ssl_option": false }
Response
- Normal response
Parameter
Description
job_id
Definition
Task ID.
Range
N/A
- Example normal response
{ "job_id":"83abc7bc-2c70-4534-8565-351187b37715" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot