forked from docs/doc-exports
Hasko, Vladimir
c1056e5100
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
195 lines
14 KiB
HTML
195 lines
14 KiB
HTML
<a name="DeleteGaussMySqlProxy"></a><a name="DeleteGaussMySqlProxy"></a>
|
|
|
|
<h1 class="topictitle1">Disabling Database Proxy</h1>
|
|
<div id="body0000001139338461"><div class="section" id="DeleteGaussMySqlProxy__section4284989"><h4 class="sectiontitle">Function</h4><p id="DeleteGaussMySqlProxy__p0506143014918">This API is used to disable database proxy. Before using this API:</p>
|
|
<ul id="DeleteGaussMySqlProxy__ul924420236520"><li id="DeleteGaussMySqlProxy__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="DeleteGaussMySqlProxy__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li><li id="DeleteGaussMySqlProxy__li06361333113611">Database proxy is unavailable for DB instances in a DeC.</li></ul>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section155811514511"><h4 class="sectiontitle">URI</h4><p id="DeleteGaussMySqlProxy__p105971575114">DELETE /v3/{project_id}/instances/{instance_id}/proxy</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__table166061565120" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row12595150517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteGaussMySqlProxy__p1661215195112">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteGaussMySqlProxy__p106171585120">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteGaussMySqlProxy__p862215185116">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteGaussMySqlProxy__p7634159514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row4609150515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteGaussMySqlProxy__p164615105118">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteGaussMySqlProxy__p46411520515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p116541565119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p17636229447">Project ID of a tenant in a region.</p>
|
|
<p id="DeleteGaussMySqlProxy__p8636132912413">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteGaussMySqlProxy__row116031510513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteGaussMySqlProxy__p196713158513">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteGaussMySqlProxy__p1267415135119">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p36821525120">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p86931565110">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section1170141545113"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row171161510511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteGaussMySqlProxy__p197251512519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteGaussMySqlProxy__p1673141517518">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteGaussMySqlProxy__p16732157518">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteGaussMySqlProxy__p17741215165111">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row10711715165119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteGaussMySqlProxy__p87519152513">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteGaussMySqlProxy__p675181517518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p3761015145112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p677161519515">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteGaussMySqlProxy__row1271815105118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteGaussMySqlProxy__p11781015115113">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteGaussMySqlProxy__p078131505113">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p17921525111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p880815175111">Language.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__request_CloseMysqlProxyRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row2811015115112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="DeleteGaussMySqlProxy__p168261525111">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="DeleteGaussMySqlProxy__p148216153516">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="DeleteGaussMySqlProxy__p1083215105111">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="DeleteGaussMySqlProxy__p15841815205119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row481171595117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteGaussMySqlProxy__p185201510511">proxy_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteGaussMySqlProxy__p1185181511511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteGaussMySqlProxy__p186121545116">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteGaussMySqlProxy__p158718154518">Proxy instance IDs. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, this parameter must be specified.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section16881615125110"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteGaussMySqlProxy__p178914157514"><strong id="DeleteGaussMySqlProxy__b25632023825053">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__response_MysqlJobId" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row6901715165110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteGaussMySqlProxy__p9911915185118">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteGaussMySqlProxy__p1091111515514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteGaussMySqlProxy__p09217150513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row39010151515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteGaussMySqlProxy__p1393815125119">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteGaussMySqlProxy__p4941915205119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteGaussMySqlProxy__p394191518516">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="DeleteGaussMySqlProxy__p149551516512"><strong id="DeleteGaussMySqlProxy__b11099120825247">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row096215145120"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="DeleteGaussMySqlProxy__p09751515116">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="DeleteGaussMySqlProxy__p698111595113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="DeleteGaussMySqlProxy__p498191518517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row10961015115116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="DeleteGaussMySqlProxy__p1299161513518">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="DeleteGaussMySqlProxy__p1010091575119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="DeleteGaussMySqlProxy__p5101171545111">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteGaussMySqlProxy__row10961715145115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="DeleteGaussMySqlProxy__p410120155516">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="DeleteGaussMySqlProxy__p14102191585117">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="DeleteGaussMySqlProxy__p19103131565117">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="DeleteGaussMySqlProxy__p5104815185113"><strong id="DeleteGaussMySqlProxy__b1010412154517">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteGaussMySqlProxy__table610431545112" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteGaussMySqlProxy__row8104515125119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="DeleteGaussMySqlProxy__p171051315165118">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="DeleteGaussMySqlProxy__p7106141555114">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="DeleteGaussMySqlProxy__p210771519517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteGaussMySqlProxy__row110419153513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="DeleteGaussMySqlProxy__p1310831512512">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="DeleteGaussMySqlProxy__p12108315125112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="DeleteGaussMySqlProxy__p1810915156517">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteGaussMySqlProxy__row4104515115116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="DeleteGaussMySqlProxy__p10110101555116">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="DeleteGaussMySqlProxy__p15111815115116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="DeleteGaussMySqlProxy__p1711151585116">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section3112101585118"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="DeleteGaussMySqlProxy__screen178951148348">DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy
|
|
{
|
|
"proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section143351243153618"><h4 class="sectiontitle">Example Response</h4><p id="DeleteGaussMySqlProxy__p178952145345"><strong id="DeleteGaussMySqlProxy__b1469132144018">Status code: 200</strong></p>
|
|
<p id="DeleteGaussMySqlProxy__p1989541483416">Success.</p>
|
|
<pre class="screen" id="DeleteGaussMySqlProxy__screen11895714143412">{
|
|
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="DeleteGaussMySqlProxy__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="DeleteGaussMySqlProxy__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="DeleteGaussMySqlProxy__p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000006.html">Database Proxy</a></div>
|
|
</div>
|
|
</div>
|
|
|