forked from docs/doc-exports
Chen, Junjie
7f68b84da4
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
189 lines
17 KiB
HTML
189 lines
17 KiB
HTML
<a name="kafka-api-180514006"></a><a name="kafka-api-180514006"></a>
|
|
|
|
<h1 class="topictitle1">Restarting or Deleting Instances in Batches</h1>
|
|
<div id="body1524661275118"><div class="note" id="kafka-api-180514006__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180514006__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="BatchRestartOrDeleteInstances.html">Batch Restarting or Deleting Instances</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180514006__en-us_topic_0128036898_section321013247298"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180514006__en-us_topic_0128036898_p14273112662914">This API is used to restart or delete instances in batches.</p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p137161910301">When an instance is being restarted, message retrieval and creation requests of the client will be rejected.</p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p0868165112309">Deleting an instance will delete the data in the instance without any backup. Exercise caution when performing this operation.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514006__en-us_topic_0128036898_section17897053122710"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180514006__en-us_topic_0128036898_p04055402718">POST /v1.0/{project_id}/instances/action</p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p740155411271"><a href="#kafka-api-180514006__en-us_topic_0128036898_table98991536279">Table 1</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514006__en-us_topic_0128036898_table98991536279"></a><a name="en-us_topic_0128036898_table98991536279"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514006__en-us_topic_0128036898_table98991536279" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180514006__en-us_topic_0128036898_row2421954132717"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180514006__en-us_topic_0128036898_p18421354142717">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.2"><p id="kafka-api-180514006__en-us_topic_0128036898_p1442154182712">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.3"><p id="kafka-api-180514006__en-us_topic_0128036898_p134215540272">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.4.2.5.1.4"><p id="kafka-api-180514006__en-us_topic_0128036898_p1942054192712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514006__en-us_topic_0128036898_row174218545276"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p042165452713">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p642185410277">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1742105422714">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180514006__en-us_topic_0128036898_p342155414271">Indicates the ID of a project.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514006__en-us_topic_0128036898_section20906753102710"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180514006__en-us_topic_0128036898_p15425543275"><strong id="kafka-api-180514006__b6456554692">Request parameters</strong></p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p184225412279"><a href="#kafka-api-180514006__en-us_topic_0128036898_table890715392717">Table 2</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514006__en-us_topic_0128036898_table890715392717"></a><a name="en-us_topic_0128036898_table890715392717"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514006__en-us_topic_0128036898_table890715392717" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="kafka-api-180514006__en-us_topic_0128036898_row154205417279"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.1"><p id="kafka-api-180514006__en-us_topic_0128036898_p74275452714">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.4.2.5.1.2"><p id="kafka-api-180514006__en-us_topic_0128036898_p13421654192714">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.5.1.3"><p id="kafka-api-180514006__en-us_topic_0128036898_p74245402717">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.4.4.2.5.1.4"><p id="kafka-api-180514006__en-us_topic_0128036898_p1242754122714">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514006__en-us_topic_0128036898_row942254172717"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p24295410275">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1443254122713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p174314544275">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514006__en-us_topic_0128036898_p18438543272">Indicates the operation to be performed on instances. The value of this parameter can be <strong id="kafka-api-180514006__en-us_topic_0128036898_b57981349164915">restart</strong> or <strong id="kafka-api-180514006__en-us_topic_0128036898_b1350185244918">delete</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514006__en-us_topic_0128036898_row44365416273"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p124355442710">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p343185482711">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p84335411274">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1143195410277">Indicates the list of instance IDs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514006__en-us_topic_0128036898_row22669518122"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p762912810123">allFailure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p156297819125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p162968111215">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180514006__p984618492271">When set to <strong id="kafka-api-180514006__b20155153812506">kafka</strong>, indicates all Kafka instances that fail to be created are to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p174305416271"><strong id="kafka-api-180514006__en-us_topic_0128036898_b16435728205018">Example request</strong></p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p4861232148">Restarting instances in batches:</p>
|
|
<pre class="screen" id="kafka-api-180514006__en-us_topic_0128036898_screen1343165419277">POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
|
|
{
|
|
"action" : "restart",
|
|
"instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"]
|
|
}</pre>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p3219332161413">Deleting instances in batches:</p>
|
|
<pre class="screen" id="kafka-api-180514006__en-us_topic_0128036898_screen1821933271417">POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
|
|
{
|
|
"action" : "delete",
|
|
"instances" : ["54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640"]
|
|
}</pre>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p167041477145">Deleting all instances that fail to be created:</p>
|
|
<pre class="screen" id="kafka-api-180514006__en-us_topic_0128036898_screen137059719149">POST https://{dms_endpoint}/v1.0/{project_id}/instances/action
|
|
{
|
|
"action" : "delete",
|
|
"allFailure" : "kafka"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514006__en-us_topic_0128036898_section8923953182713"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180514006__en-us_topic_0128036898_p24305410276"><strong id="kafka-api-180514006__en-us_topic_0128036898_b5616115717509">Response parameters</strong></p>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p24315548274">When <strong id="kafka-api-180514006__b91531907289">action</strong> is set to <strong id="kafka-api-180514006__b1315350172816">delete</strong>, <strong id="kafka-api-180514006__b61531702283">allFailure</strong> is set to <strong id="kafka-api-180514006__b2015310102813">kafka</strong>, and an empty response is returned, the instances are deleted successfully. <a href="#kafka-api-180514006__en-us_topic_0128036898_table189241953152710">Table 3</a> describes the parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514006__en-us_topic_0128036898_table189241953152710"></a><a name="en-us_topic_0128036898_table189241953152710"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514006__en-us_topic_0128036898_table189241953152710" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180514006__en-us_topic_0128036898_row1943054162712"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180514006__en-us_topic_0128036898_p043854162718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180514006__en-us_topic_0128036898_p174325482711">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180514006__en-us_topic_0128036898_p443254102717">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514006__en-us_topic_0128036898_row44311544276"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p124365415272">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p643205442711">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p84335442713">Indicates the result of instance modification.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514006__en-us_topic_0128036898_table1693155317278" frame="border" border="1" rules="all"><caption><b>Table 4 </b>results parameter description</caption><thead align="left"><tr id="kafka-api-180514006__en-us_topic_0128036898_row943175422716"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180514006__en-us_topic_0128036898_p20435545279">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180514006__en-us_topic_0128036898_p144315543273">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180514006__en-us_topic_0128036898_p14335418274">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514006__en-us_topic_0128036898_row204335416274"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1143195482715">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1043105422712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p4438545273">Indicates the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514006__en-us_topic_0128036898_row3431954182714"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p74345462715">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p164315415279">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180514006__en-us_topic_0128036898_p1044125413276">Indicates an operation result, which can be <strong id="kafka-api-180514006__en-us_topic_0128036898_b115401432163319">success</strong> or <strong id="kafka-api-180514006__en-us_topic_0128036898_b154018322337">failed</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180514006__en-us_topic_0128036898_p54475410275"><strong id="kafka-api-180514006__en-us_topic_0128036898_b17179174895212">Example response</strong></p>
|
|
<pre class="screen" id="kafka-api-180514006__en-us_topic_0128036898_screen244354162711">{
|
|
"results": [
|
|
{
|
|
"result": "success",
|
|
"instance": "afc90a2a-a02c-4cba-94d5-58dfa9ad1e0d"
|
|
},
|
|
{
|
|
"result": "success",
|
|
"instance": "67fc5f8d-3986-4f02-bb75-4075a23112de"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180514006__en-us_topic_0128036898_section494465382712"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180514006__en-us_topic_0128036898_p204495417276"><a href="#kafka-api-180514006__en-us_topic_0128036898_table17944125315273">Table 5</a> describes the status code of successful operations. For details about other status codes, see <a href="kafka-api-0034672261.html">Status Code</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180514006__en-us_topic_0128036898_table17944125315273"></a><a name="en-us_topic_0128036898_table17944125315273"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180514006__en-us_topic_0128036898_table17944125315273" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="kafka-api-180514006__en-us_topic_0128036898_row1745105419271"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180514006__en-us_topic_0128036898_p11451954102710">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.85000000000001%" id="mcps1.3.6.3.2.3.1.2"><p id="kafka-api-180514006__en-us_topic_0128036898_p184520544272">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180514006__en-us_topic_0128036898_row645205411275"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514006__en-us_topic_0128036898_p345155472710">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514006__en-us_topic_0128036898_p8451954152719">The instances are restarted or deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180514006__row1161083213502"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180514006__p66104324504">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180514006__p661013212508">Successfully deleting an instance failed to be created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="kafka-api-180514001.html">APIs for Managing Instances</a></div>
|
|
</div>
|
|
</div>
|
|
|