forked from docs/doc-exports
Wang , Deng Ke
60010eb9d0
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>
116 lines
9.2 KiB
HTML
116 lines
9.2 KiB
HTML
<a name="dds_api_0051"></a><a name="dds_api_0051"></a>
|
|
|
|
<h1 class="topictitle1">Enabling or Disabling SSL</h1>
|
|
<div id="body1579243011598"><div class="section" id="dds_api_0051__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0051__p3631239417316">This API is used to enable or disable SSL.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0051__ul082311820560"><li id="dds_api_0051__li12884540440">This operation cannot be performed on frozen or abnormal instances.</li><li id="dds_api_0051__li172525991915">The DB instance must be restarted to make port number modifications take effect. Exercise caution when enabling or disabling SSL.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0051__ul3084351717316"><li id="dds_api_0051__li915620217316">URI format<p id="dds_api_0051__p912862005412"><a name="dds_api_0051__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switch-ssl</p>
|
|
</li><li id="dds_api_0051__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0051__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0051__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0051__p34889605">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0051__p7485743">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0051__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0051__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0051__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0051__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0051__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0051__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0051__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0051__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0051__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0051__ul5099287616954"><li id="dds_api_0051__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0051__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0051__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17.18%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0051__p1204887716954">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.740000000000002%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0051__p15184124818564">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.64%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0051__p3643495116954">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.44%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0051__p222501215320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0051__row794180116954"><td class="cellrowborder" valign="top" width="17.18%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0051__p1144272813450">ssl_option</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.740000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0051__p124421528134515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0051__p644214287459">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.44%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0051__p18442528114510">Specifies whether to enable or disable SSL.</p>
|
|
<p id="dds_api_0051__p6442112844514">Valid value:</p>
|
|
<ul id="dds_api_0051__ul1967518129221"><li id="dds_api_0051__li10675181222215">The value <strong id="dds_api_0051__b1967551219225">0</strong> indicates that SSL is requested to be disabled.</li><li id="dds_api_0051__li206752129223">The value <strong id="dds_api_0051__b18675111282214">1</strong> indicates that SSL is requested to be enabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0051__ul1041877316954"><li id="dds_api_0051__li2666010016954">Example request<div class="p" id="dds_api_0051__p623563418814"><a name="dds_api_0051__li2666010016954"></a><a name="li2666010016954"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switch-ssl<pre class="codeblock" id="dds_api_0051__codeblock51961433784">{
|
|
"ssl_option": "0"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0051__ul12573920"><li id="dds_api_0051__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0051__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0051__row9230088"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0051__p9439626"><strong id="dds_api_0051__b6709162611565">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0051__p26412257"><strong id="dds_api_0051__b12649132713562">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0051__p327014214317"><strong id="dds_api_0051__b16414152810569">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0051__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0051__p10877153310467">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0051__p1687753354614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0051__p8877633134614">Indicates the workflow ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0051__row6917102864619"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0051__p1287783319467">ssl_option</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0051__p287773364614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0051__p1987783314611">Indicates whether to enable or disable SSL.</p>
|
|
<p id="dds_api_0051__p118771633164615">Valid value:</p>
|
|
<ul id="dds_api_0051__ul4877733194615"><li id="dds_api_0051__li575145719214">The value <strong id="dds_api_0051__b576175714218">0</strong> indicates that SSL is requested to be disabled.</li><li id="dds_api_0051__li14877173344614">The value <strong id="dds_api_0051__b176961441132112">1</strong> indicates that SSL is requested to be enabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0051__ul16665627"><li id="dds_api_0051__li15772917">Response example<pre class="codeblock" id="dds_api_0051__codeblock660937479172">{
|
|
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
|
"ssl_option": "0"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0051__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0051__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0051__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0051__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|