forked from docs/doc-exports
Wang , Deng Ke
21e968a153
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
93 lines
11 KiB
HTML
93 lines
11 KiB
HTML
<a name="rds_05_0017"></a><a name="rds_05_0017"></a>
|
|
|
|
<h1 class="topictitle1">Configuring SSL</h1>
|
|
<div id="body32001227"><p id="rds_05_0017__p192398171366">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:</p>
|
|
<ul id="rds_05_0017__ul49161418176"><li id="rds_05_0017__li14673321272">Authenticates users and servers, ensuring that data is sent to the correct clients and servers.</li><li id="rds_05_0017__li1283819359715">Encrypts data, preventing it from being intercepted during transmission.</li><li id="rds_05_0017__li1791615182077">Ensures data integrity during transmission.</li></ul>
|
|
<p id="rds_05_0017__p137809400168">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.</p>
|
|
<div class="section" id="rds_05_0017__en-us_topic_0238844974_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0017__en-us_topic_0238844974_p19142153232816">This API is used to configure SSL to encrypt connections.</p>
|
|
<ul id="rds_05_0017__en-us_topic_0238844974_ul12259155218373"><li id="rds_05_0017__en-us_topic_0238844974_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_05_0017__en-us_topic_0238844974_en-us_topic_0110967248_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__en-us_topic_0238844974_section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0017__ul9684141142"><li id="rds_05_0017__li16841542420">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.</li></ul>
|
|
<ul id="rds_05_0017__ul45751821138"><li id="rds_05_0017__en-us_topic_0231317996_li446114114503">This API is supported for MySQL only.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__en-us_topic_0238844974_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0017__en-us_topic_0238844974_ul53354139141429"><li id="rds_05_0017__en-us_topic_0238844974_li1270098217262">URI format<p id="rds_05_0017__en-us_topic_0238844974_p30251930154721"><a name="rds_05_0017__en-us_topic_0238844974_li1270098217262"></a><a name="en-us_topic_0238844974_li1270098217262"></a>PUT https://{<em id="rds_05_0017__en-us_topic_0238844974_i2475051121512">Endpoint</em>}/v3/{<em id="rds_05_0017__en-us_topic_0238844974_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0017__en-us_topic_0238844974_i923712547">instance_id</em>}/ssl</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0017__en-us_topic_0238844974_ul49831254144655"><li id="rds_05_0017__en-us_topic_0238844974_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0017__en-us_topic_0238844974_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0017__en-us_topic_0238844974_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.6.3.1.1.2.4.1.1"><p id="rds_05_0017__en-us_topic_0238844974_p34889605"><strong id="rds_05_0017__en-us_topic_0238844974_b112353209591">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.6.3.1.1.2.4.1.2"><p id="rds_05_0017__en-us_topic_0238844974_p7485743"><strong id="rds_05_0017__en-us_topic_0238844974_b495192015917">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.6.3.1.1.2.4.1.3"><p id="rds_05_0017__en-us_topic_0238844974_p2365466"><strong id="rds_05_0017__en-us_topic_0238844974_b8542182113593">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0017__en-us_topic_0238844974_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.6.3.1.1.2.4.1.1 "><p id="rds_05_0017__en-us_topic_0238844974_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.6.3.1.1.2.4.1.2 "><p id="rds_05_0017__en-us_topic_0238844974_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.6.3.1.1.2.4.1.3 "><p id="rds_05_0017__en-us_topic_0238844974_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0017__en-us_topic_0238844974_p14611855135510">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0017__en-us_topic_0238844974_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.6.3.1.1.2.4.1.1 "><p id="rds_05_0017__en-us_topic_0238844974_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.6.3.1.1.2.4.1.2 "><p id="rds_05_0017__en-us_topic_0238844974_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.6.3.1.1.2.4.1.3 "><p id="rds_05_0017__en-us_topic_0238844974_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__en-us_topic_0238844974_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0017__en-us_topic_0238844974_ul5099287616954"><li id="rds_05_0017__en-us_topic_0238844974_li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0017__en-us_topic_0238844974_table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0017__en-us_topic_0238844974_row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.7.2.1.1.2.5.1.1"><p id="rds_05_0017__en-us_topic_0238844974_p17490046"><strong id="rds_05_0017__en-us_topic_0238844974_b103881211518">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.7.2.1.1.2.5.1.2"><p id="rds_05_0017__en-us_topic_0238844974_p7407659"><strong id="rds_05_0017__en-us_topic_0238844974_b173981725110">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.7.2.1.1.2.5.1.3"><p id="rds_05_0017__en-us_topic_0238844974_p63149496"><strong id="rds_05_0017__en-us_topic_0238844974_b47255220118">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.7.2.1.1.2.5.1.4"><p id="rds_05_0017__en-us_topic_0238844974_p14835533"><strong id="rds_05_0017__en-us_topic_0238844974_b5371635110">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0017__en-us_topic_0238844974_row60827539"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.7.2.1.1.2.5.1.1 "><p id="rds_05_0017__en-us_topic_0238844974_p28083633">ssl_option</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.7.2.1.1.2.5.1.2 "><p id="rds_05_0017__en-us_topic_0238844974_p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.7.2.1.1.2.5.1.3 "><p id="rds_05_0017__en-us_topic_0238844974_p42890904">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.7.2.1.1.2.5.1.4 "><p id="rds_05_0017__en-us_topic_0238844974_p19899179406">Specifies whether to enable SSL.</p>
|
|
<ul id="rds_05_0017__en-us_topic_0238844974_ul889593413441"><li id="rds_05_0017__en-us_topic_0238844974_li158961534154419"><strong id="rds_05_0017__en-us_topic_0238844974_b83715341612">true</strong>: SSL is enabled.</li><li id="rds_05_0017__en-us_topic_0238844974_li68967342449"><strong id="rds_05_0017__en-us_topic_0238844974_b1984054717616">false</strong>: SSL is disabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0017__ul41741477385"><li id="rds_05_0017__li4411135064210">Example<p id="rds_05_0017__p1454414211213"><a name="rds_05_0017__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0017__en-us_topic_0238844974_ul18318676175816"><li id="rds_05_0017__en-us_topic_0238844974_li30650356175816">Request example<pre class="codeblock" id="rds_05_0017__en-us_topic_0238844974_codeblock26701898174649">{
|
|
"ssl_option": true
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__en-us_topic_0238844974_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0017__en-us_topic_0238844974_ul16665627"><li id="rds_05_0017__en-us_topic_0238844974_li15772917">Example normal response<pre class="codeblock" id="rds_05_0017__en-us_topic_0238844974_codeblock314170531760">{}</pre>
|
|
</li><li id="rds_05_0017__en-us_topic_0238844974_li68218279114">Abnormal response<p id="rds_05_0017__en-us_topic_0238844974_p28475059"><a name="rds_05_0017__en-us_topic_0238844974_li68218279114"></a><a name="en-us_topic_0238844974_li68218279114"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0017__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0017__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0017__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0017__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0017__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0017__en-us_topic_0032347778_p0723374409"><a name="rds_05_0017__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0017__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0017__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_07_0000.html">Database Security</a></div>
|
|
</div>
|
|
</div>
|
|
|