forked from docs/doc-exports
Ru, Li Yi
37b97ffc06
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
107 lines
7.3 KiB
HTML
107 lines
7.3 KiB
HTML
<a name="nosql_05_0015"></a><a name="nosql_05_0015"></a>
|
|
|
|
<h1 class="topictitle1">Deleting an Instance</h1>
|
|
<div id="body1088017855115"><div class="section" id="nosql_05_0015__section1880178105110"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0015__p1888119815112">This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section1732516875115"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0015__p153256865116">This API supports GeminiDB Cassandra instances.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section189003825117"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0015__p17901158165113">DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__table59045845117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0015__row2902489512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0015__p1490412819512">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0015__p8905158185118">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_05_0015__p39063855115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_05_0015__p390716895112">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0015__row890216810519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0015__p29080815512">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0015__p8909188155110">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0015__p1691017855112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0015__p1391116813511">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_05_0015__row1590211885113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0015__p189128835111">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0015__p17913128195110">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0015__p179131586517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0015__p79148813513">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section11915158185113"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0015__row691616875119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0015__p99181184519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0015__p19919884511">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0015__p092018155112">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0015__p692111814517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0015__row0916188135115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0015__p1592215812512">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0015__p209234815516">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0015__p149246814514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0015__p992514811518">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section092612819515"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0015__p6927168155115"><strong id="nosql_05_0015__b4501144211218">Status code: 202</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0015__response_DeleteInstanceResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0015__row139292820514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0015__p6930198105114">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_05_0015__p693218895119">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_05_0015__p29331082515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_05_0015__row1992915816514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0015__p8933138115111">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0015__p693418815111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0015__p139371488516">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section159386819516"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_05_0015__p1817918183245">URI example<pre class="screen" id="nosql_05_0015__screen17649159123315">DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section1694310814519"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0015__p11944989519"><strong id="nosql_05_0015__b15435046102111">Status code: 202</strong></p>
|
|
<p id="nosql_05_0015__p179442328277">Accepted</p>
|
|
<pre class="screen" id="nosql_05_0015__screen59461384518">{
|
|
"job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0015__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="nosql_05_0015__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0015__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|