forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
119 lines
11 KiB
HTML
119 lines
11 KiB
HTML
<a name="rds_05_0081"></a><a name="rds_05_0081"></a>
|
|
|
|
<h1 class="topictitle1">Enabling TDE for a DB Instance (RDS for SQL Server)</h1>
|
|
<div id="body0000002475088184"><div class="section" id="rds_05_0081__section4284989"><h4 class="sectiontitle">Function</h4><p id="rds_05_0081__p165771016141612"><span class="keyword" id="rds_05_0081__keyword921313534415">Transparent Data Encryption (TDE)</span> performs real-time I/O encryption and decryption on data files. Data is encrypted before being written to disks and is decrypted when being read from disks to memory. This effectively protects the security of databases and data files. This API is used to enable TDE for a DB instance.</p>
|
|
<ul id="rds_05_0081__ul12259155218373"><li id="rds_05_0081__en-us_topic_0240111818_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_0081__en-us_topic_0240111818_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_0081__en-us_topic_0000001719599024_section31274517367"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0081__en-us_topic_0000001719599024_ul1812716517365"><li id="rds_05_0081__en-us_topic_0000001719599024_li1212785111368">This API supports only RDS for SQL Server instances.</li><li id="rds_05_0081__en-us_topic_0000001719599024_li6688105973610">TDE cannot be disabled after being enabled, and it cannot be enabled again.</li><li id="rds_05_0081__en-us_topic_0000001719599024_li20233173513716">The DB engine of the target instance must be of the Enterprise Edition, 2019 Standard Edition, or 2022 Standard Edition.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0081__section38564907"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0081__ul13194498"><li id="rds_05_0081__li51641620">URI format<p id="rds_05_0081__p192210412203"><a name="rds_05_0081__li51641620"></a><a name="li51641620"></a>PUT https://{<em id="rds_05_0081__i1228418204">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/tde</p>
|
|
</li><li id="rds_05_0081__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0081__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0081__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_05_0081__p10809459"><strong id="rds_05_0081__b87883437564">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_05_0081__p3150961"><strong id="rds_05_0081__b14592104411564">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_05_0081__p53901255"><strong id="rds_05_0081__b5344045105618">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0081__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_05_0081__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_05_0081__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_05_0081__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0081__p178064411566">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_0081__row1694185313436"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_05_0081__en-us_topic_0000001719599024_en-us_topic_0000001473542157_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_05_0081__en-us_topic_0000001719599024_en-us_topic_0000001473542157_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_05_0081__en-us_topic_0000001719599024_en-us_topic_0000001473542157_p64450739155220">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0081__section1390010340492"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0081__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_05_0081__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_05_0081__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="rds_05_0081__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="rds_05_0081__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="rds_05_0081__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0081__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0081__p18511533163317">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_05_0081__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0081__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0081__p35111331332">The content type.</p>
|
|
<p id="rds_05_0081__p1351133311330">The default value is <strong id="rds_05_0081__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0081__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0081__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_05_0081__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0081__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0081__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_05_0081__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_05_0081__section582371816458"><h4 class="sectiontitle">Example Request</h4><div class="p" id="rds_05_0081__p15830121115510">Enable TDE for a DB instance.<pre class="screen" id="rds_05_0081__screen1369515467814">PUT https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde
|
|
|
|
{}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_05_0081__section36749739"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0081__ul48268995"><li id="rds_05_0081__li31767774">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0081__table17474517" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0081__row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_05_0081__p32787233"><strong id="rds_05_0081__b171061828577">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.29%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_05_0081__p38520254"><strong id="rds_05_0081__b1767918315577">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_05_0081__p33132859"><strong id="rds_05_0081__b103516420578">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0081__row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_05_0081__en-us_topic_0000001719599024_en-us_topic_0000001473542157_p10824125423812">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_05_0081__en-us_topic_0000001719599024_en-us_topic_0000001473542157_p1382475412387">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_05_0081__en-us_topic_0000001719599024_p12508115622210">Taskflow ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0081__ul199862024192715"><li id="rds_05_0081__li12985172416272">Example normal response<pre class="screen" id="rds_05_0081__en-us_topic_0000001719599024_screen8533130599">{
|
|
"job_id":"2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="rds_05_0081__li1098602419271">Abnormal Response<p id="rds_05_0081__p798642452719"><a name="rds_05_0081__li1098602419271"></a><a name="li1098602419271"></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_0081__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0081__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0081__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0081__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0081__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_05_0081__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0081__en-us_topic_0032347778_p0723374409"><a name="rds_05_0081__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_0081__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0081__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="rds_05_0081__p8060118"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|