Configuring SSL¶

Secure Socket Layer (SSL) is an encryption-based Internet security protocol for establishing an encrypted link between a server and a client. It provides authenticated Internet connections to ensure the privacy and integrity of online communications. SSL:

Authenticates users and servers, ensuring that data is sent to the correct clients and servers.
Encrypts data, preventing it from being intercepted during transmission.
Ensures data integrity during transmission.

Clients using versions earlier than 5.1 have SSL compatibility issues. By default, SSL is disabled for new RDS for MySQL instances. If your client has no SSL compatibility issues, you can enable SSL. Enabling SSL will increase the network connection response time and CPU resource consumption. Before configuring it, evaluate any potential impacts on service performance.

Function¶

This API is used to configure SSL to encrypt connections.

Before calling an API, you need to understand the API in Authentication.
Before calling this API, obtain the required region and endpoint.

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 for MySQL only.

URI¶

URI format
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl

Parameter description

**Table 1** Parameter description¶
Name	Mandatory	Description
project_id	Yes	Specifies the project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
instance_id	Yes	Specifies the DB instance ID.

Request¶

Parameter description
Table 2 Parameter description¶
Name
Mandatory
Type
Description
ssl_option
Yes
boolean
Specifies whether to enable SSL.
true: SSL is enabled.
false: SSL is disabled.
Example
PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl
Request example
```
{
     "ssl_option": true
}
```

**Table 2** Parameter description¶
Name	Mandatory	Type	Description
ssl_option	Yes	boolean	Specifies whether to enable SSL. true: SSL is enabled. false: SSL is disabled.

Response¶

Example normal response
```
{}
```
Abnormal response
For details, see Abnormal Request Results.

Status Code¶

Normal
200
Abnormal
For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-18 01:11