forked from docs/doc-exports
Dong, Qiu Jian
3bfd56205d
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
104 lines
8.1 KiB
HTML
104 lines
8.1 KiB
HTML
<a name="cce_02_0324"></a><a name="cce_02_0324"></a>
|
|
|
|
<h1 class="topictitle1">Deleting an Add-on Instance</h1>
|
|
<div id="body1595231617760"><div class="section" id="cce_02_0324__section293419499713"><h4 class="sectiontitle">Function</h4><p id="cce_02_0324__p993584917718">This API is used to delete an add-on instance.</p>
|
|
<div class="note" id="cce_02_0324__note42209401757"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="cce_02_0324__p8220640955">The URL for add-on management is in the format of <strong id="cce_02_0324__b598718254523">https://{clusterid}.Endpoint/uri.</strong> In the URL, <em id="cce_02_0324__i1485018501457">{clusterid}</em> indicates the cluster ID, and <em id="cce_02_0324__i198501050458">uri</em> indicates the resource path, that is, the path for API access.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="cce_02_0324__section189350497716"><h4 class="sectiontitle">URI</h4><p id="cce_02_0324__p193617492711">DELETE /api/v3/addons/{id}?cluster_id={cluster_id}</p>
|
|
<p id="cce_02_0324__p101731719174319"><a href="#cce_02_0324__table493910491373">Table 1</a> describes the parameters of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0324__table493910491373"></a><a name="table493910491373"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0324__table493910491373" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0324__row1693894920717"><th align="left" class="cellrowborder" valign="top" width="17.95%" id="mcps1.3.2.4.2.5.1.1"><p id="cce_02_0324__p129401491177">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.71%" id="mcps1.3.2.4.2.5.1.2"><p id="cce_02_0324__p4421354844">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.380000000000003%" id="mcps1.3.2.4.2.5.1.3"><p id="cce_02_0324__p199401491576">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.96000000000001%" id="mcps1.3.2.4.2.5.1.4"><p id="cce_02_0324__p594211496717">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0324__row89385497714"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0324__p4943749474">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0324__p205342313510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0324__p149448492076">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.96000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0324__p15106445114416">Cluster ID. For details about how to obtain the cluster ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0324__row18938349479"><td class="cellrowborder" valign="top" width="17.95%" headers="mcps1.3.2.4.2.5.1.1 "><p id="cce_02_0324__p1794634912710">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.71%" headers="mcps1.3.2.4.2.5.1.2 "><p id="cce_02_0324__p18534193357">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.2.4.2.5.1.3 "><p id="cce_02_0324__p1947104918710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.96000000000001%" headers="mcps1.3.2.4.2.5.1.4 "><p id="cce_02_0324__p152383501074">Add-on instance ID. For details about how to obtain the ID, see <a href="cce_02_0323.html#cce_02_0323__table12181142512286">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cce_02_0324__section169491849875"><h4 class="sectiontitle">Request</h4><p id="cce_02_0324__p171790883418"><strong id="cce_02_0324__b1363222711574">Request parameters:</strong></p>
|
|
<p id="cce_02_0324__p10411132717342"><a href="#cce_02_0324__table061744914219">Table 2</a> list the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0324__table061744914219"></a><a name="table061744914219"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0324__table061744914219" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0324__cce_02_0236_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0324__cce_02_0236_p115009545264">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.4.2.4.1.2"><p id="cce_02_0324__cce_02_0236_p175001547265">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.4.2.4.1.3"><p id="cce_02_0324__cce_02_0236_p16500154162611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0324__cce_02_0236_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0324__cce_02_0236_p69808112344">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0324__cce_02_0236_p3980111103414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0324__cce_02_0236_p169801011203416">Message body type (format).</p>
|
|
<p id="cce_02_0324__p10511125693019">Default: <strong id="cce_02_0324__b47397406315">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0324__cce_02_0236_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0324__cce_02_0236_p105001654202618">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0324__cce_02_0236_p20500954182618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0324__p6704114410917">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details on how to obtain a user token, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0324__p12555125043412"><strong id="cce_02_0324__b12756175955718">Example request:</strong></p>
|
|
<p id="cce_02_0324__p43871419162310">N/A</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0324__section171345501278"><h4 class="sectiontitle">Response</h4><p id="cce_02_0324__p1913513509713"><strong id="cce_02_0324__b117121015586">Response parameters:</strong></p>
|
|
<p id="cce_02_0324__p5916201717357">N/A</p>
|
|
<p id="cce_02_0324__p14449142473510"><strong id="cce_02_0324__b65441124583">Example response:</strong></p>
|
|
<pre class="screen" id="cce_02_0324__screen1165918261260">success</pre>
|
|
</div>
|
|
<div class="section" id="cce_02_0324__section194651851070"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0324__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="cce_02_0324__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="19.96%" id="mcps1.3.5.2.2.3.1.1"><p id="cce_02_0324__p55616028205955">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="80.04%" id="mcps1.3.5.2.2.3.1.2"><p id="cce_02_0324__p8604418205955">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0324__row176274101210"><td class="cellrowborder" valign="top" width="19.96%" headers="mcps1.3.5.2.2.3.1.1 "><p id="cce_02_0324__p46285101728">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.04%" headers="mcps1.3.5.2.2.3.1.2 "><p id="cce_02_0324__p126288106215">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0324__p347213715512">For the description about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0320.html">Add-on Management</a></div>
|
|
</div>
|
|
</div>
|
|
|