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>
115 lines
11 KiB
HTML
115 lines
11 KiB
HTML
<a name="rds_05_0082"></a><a name="rds_05_0082"></a>
|
|
|
|
<h1 class="topictitle1">Querying TDE Status of a DB Instance (RDS for SQL Server)</h1>
|
|
<div id="body0000002475248102"><div class="section" id="rds_05_0082__section4284989"><h4 class="sectiontitle">Function</h4><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p195962011012">This API is used to query the TDE status.</p>
|
|
<ul id="rds_05_0082__ul12259155218373"><li id="rds_05_0082__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_0082__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_0082__en-us_topic_0000001719599024_section31274517367"><h4 class="sectiontitle">Constraints</h4><p id="rds_05_0082__p1634311014220">This API supports only RDS for SQL Server instances.</p>
|
|
</div>
|
|
<div class="section" id="rds_05_0082__section38564907"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0082__ul13194498"><li id="rds_05_0082__li51641620">URI format<p id="rds_05_0082__p192210412203"><a name="rds_05_0082__li51641620"></a><a name="li51641620"></a>GET https://{<em id="rds_05_0082__i1228418204">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/tde-status</p>
|
|
</li><li id="rds_05_0082__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0082__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0082__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_0082__p10809459"><strong id="rds_05_0082__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_0082__p3150961"><strong id="rds_05_0082__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_0082__p53901255"><strong id="rds_05_0082__b5344045105618">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0082__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_05_0082__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_0082__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_0082__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0082__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_0082__row9445957161310"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_05_0082__en-us_topic_0000001767399601_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_0082__en-us_topic_0000001767399601_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_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p64450739155220">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0082__section1390010340492"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0082__en-us_topic_0000001767399601_ul633062115465"><li id="rds_05_0082__en-us_topic_0000001767399601_li11417926134616">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0082__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_05_0082__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_05_0082__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_05_0082__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_05_0082__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_05_0082__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0082__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0082__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0082__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_05_0082__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_05_0082__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_05_0082__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>
|
|
</li><li id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_li4411135064210">URI example<pre class="screen" id="rds_05_0082__en-us_topic_0000001767399601_screen15841440016">GET https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin04/tde-status</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0082__section36749739"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0082__ul48268995"><li id="rds_05_0082__li31767774">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0082__table17474517" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0082__row16146366"><th align="left" class="cellrowborder" valign="top" width="26.38%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_05_0082__p32787233"><strong id="rds_05_0082__b171061828577">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.29%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_05_0082__p38520254"><strong id="rds_05_0082__b1767918315577">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_05_0082__p33132859"><strong id="rds_05_0082__b103516420578">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0082__row1625804435012"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p10824125423812">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p1382475412387">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0082__en-us_topic_0000001767399601_p3568735145519">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0082__row19937634121412"><td class="cellrowborder" valign="top" width="26.38%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p28242540384">tde_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.29%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p7824254183813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_p1982465415389">TDE status. Enumerated values:</p>
|
|
<ul id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_ul198251554173813"><li id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_li5826454113818"><strong id="rds_05_0082__b124802586475">open</strong>: Enabled</li><li id="rds_05_0082__en-us_topic_0000001767399601_en-us_topic_0000001473542157_li582675463814"><strong id="rds_05_0082__b103871651483">close</strong>: Disabled</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0082__ul199862024192715"><li id="rds_05_0082__li12985172416272">Example normal response<pre class="screen" id="rds_05_0082__en-us_topic_0000001767399601_screen372242819117">{
|
|
"instance_id":"3d39c18788b54a919bab633874c159dfin04",
|
|
"tde_status":"open"
|
|
}</pre>
|
|
</li><li id="rds_05_0082__li1098602419271">Abnormal Response<p id="rds_05_0082__p798642452719"><a name="rds_05_0082__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_0082__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0082__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0082__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0082__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0082__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0082__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0082__en-us_topic_0032347778_p0723374409"><a name="rds_05_0082__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_0082__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0082__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="rds_05_0082__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>
|
|
|