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>
111 lines
10 KiB
HTML
111 lines
10 KiB
HTML
<a name="rds_21_0005"></a><a name="rds_21_0005"></a>
|
|
|
|
<h1 class="topictitle1">Disabling Database Proxy</h1>
|
|
<div id="body0000002474577038"><div class="section" id="rds_21_0005__en-us_topic_0000001789916316_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_21_0005__en-us_topic_0000001740085332_p52780252141331">This API is used to disable database proxy of a DB instance.</p>
|
|
<ul id="rds_21_0005__ul10163594121"><li id="rds_21_0005__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_21_0005__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_21_0005__en-us_topic_0000001789916316_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_21_0005__en-us_topic_0000001789916316_ul16391217184115"><li id="rds_21_0005__en-us_topic_0000001789916316_li363951734111">URI format<p id="rds_21_0005__en-us_topic_0000001789916316_p119751919257"><a name="rds_21_0005__en-us_topic_0000001789916316_li363951734111"></a><a name="en-us_topic_0000001789916316_li363951734111"></a>DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}</p>
|
|
</li></ul>
|
|
<ul id="rds_21_0005__en-us_topic_0000001789916316_ul49831254144655"><li id="rds_21_0005__en-us_topic_0000001789916316_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_21_0005__en-us_topic_0000001789916316_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_21_0005__en-us_topic_0000001789916316_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_21_0005__en-us_topic_0000001789916316_p34889605"><strong id="rds_21_0005__b148181623208">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_21_0005__en-us_topic_0000001789916316_p7485743"><strong id="rds_21_0005__b83331922019">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_21_0005__en-us_topic_0000001789916316_p2365466"><strong id="rds_21_0005__b1849119172201">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_21_0005__en-us_topic_0000001789916316_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_21_0005__en-us_topic_0000001789916316_p69633355250">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_21_0005__en-us_topic_0000001789916316_p13963113520251">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_21_0005__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_21_0005__p27281110194">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_21_0005__en-us_topic_0000001789916316_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_21_0005__en-us_topic_0000001789916316_p3963163516252">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_21_0005__en-us_topic_0000001789916316_p20963335192520">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_21_0005__p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_21_0005__row6786144815463"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_21_0005__en-us_topic_0000001739926168_p777716462256">proxy_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_21_0005__en-us_topic_0000001739926168_p117774461252">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_21_0005__p6281185413422">Database proxy ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_21_0005__en-us_topic_0000001789916316_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_21_0005__en-us_topic_0000001740085332_ul5099287616954"><li id="rds_21_0005__en-us_topic_0000001740085332_li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_21_0005__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_21_0005__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_21_0005__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_21_0005__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_21_0005__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_21_0005__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_21_0005__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_21_0005__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_21_0005__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_21_0005__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_21_0005__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_21_0005__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_21_0005__en-us_topic_0000001740085332_li4411135064210">URI example<pre class="screen" id="rds_21_0005__screen98741712059">DELETE https://rds.eu-de.otc.t-systems.com/v3/23a50154cf494ec9ad6883979a12db0a/instances/ba0fd7c13cca4655820e0f858d5d467bin01/proxy/4e2a0c70f70f4807940db73a30b5b522po01</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_21_0005__en-us_topic_0000001789916316_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_21_0005__en-us_topic_0000001789916316_ul12573920"><li id="rds_21_0005__en-us_topic_0000001789916316_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_21_0005__en-us_topic_0000001789916316_table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_21_0005__en-us_topic_0000001789916316_row9230088"><th align="left" class="cellrowborder" valign="top" width="22.5022502250225%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_21_0005__en-us_topic_0000001789916316_p9439626"><strong id="rds_21_0005__b1161548796">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.24292429242924%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_21_0005__en-us_topic_0000001789916316_p26412257"><strong id="rds_21_0005__b1796210491596">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.254825482548256%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_21_0005__en-us_topic_0000001789916316_p59018101"><strong id="rds_21_0005__b1294617513914">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_21_0005__en-us_topic_0000001789916316_row15736877"><td class="cellrowborder" valign="top" width="22.5022502250225%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_21_0005__en-us_topic_0000001789916316_p161271527154616">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.24292429242924%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_21_0005__en-us_topic_0000001789916316_p612716271466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.254825482548256%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_21_0005__en-us_topic_0000001789916316_p81271127164612">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_21_0005__en-us_topic_0000001789916316_ul16665627"><li id="rds_21_0005__en-us_topic_0000001789916316_li15772917">Example normal response<pre class="screen" id="rds_21_0005__screen1773795643512">{
|
|
"job_id" : "09908118-8e32-4742-982a-7be194f59e1d"
|
|
}</pre>
|
|
</li><li id="rds_21_0005__en-us_topic_0000001789916316_li28023262501">Abnormal response<p id="rds_21_0005__en-us_topic_0000001789916316_p28475059"><a name="rds_21_0005__en-us_topic_0000001789916316_li28023262501"></a><a name="en-us_topic_0000001789916316_li28023262501"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_21_0005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_21_0005__en-us_topic_0110967248_ul7858132212142"><li id="rds_21_0005__en-us_topic_0110967248_li58581622171411">Normal<p id="rds_21_0005__en-us_topic_0110967248_p1040982941020"><a name="rds_21_0005__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>202</p>
|
|
</li><li id="rds_21_0005__en-us_topic_0110967248_li11583183218149">Abnormal<p id="rds_21_0005__en-us_topic_0110967248_p65078394148"><a name="rds_21_0005__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_21_0005__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="rds_21_0005__en-us_topic_0110967248_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_21_0000.html">Database Proxy (RDS for MySQL)</a></div>
|
|
</div>
|
|
</div>
|
|
|