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>
157 lines
13 KiB
HTML
157 lines
13 KiB
HTML
<a name="kafka-api-180614003"></a><a name="kafka-api-180614003"></a>
|
|
|
|
<h1 class="topictitle1">Deleting Topics in a Kafka Instance in Batches</h1>
|
|
<div id="body1526386013696"><div class="note" id="kafka-api-180614003__note159644115208"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="kafka-api-180614003__p0964111132019">This API is out-of-date and may not be maintained in the future. Please use the API described in <a href="BatchDeleteInstanceTopic.html">Batch Deleting Topics of a Kafka Instance</a>.</p>
|
|
</div></div>
|
|
<div class="section" id="kafka-api-180614003__en-us_topic_0128036887_section281017251256"><h4 class="sectiontitle">Function</h4><p id="kafka-api-180614003__en-us_topic_0128036887_p810517262255">This API is used to delete topics in a Kafka instance in batches.</p>
|
|
</div>
|
|
<div class="section" id="kafka-api-180614003__en-us_topic_0128036887_section2989194312512"><h4 class="sectiontitle">URI</h4><p id="kafka-api-180614003__en-us_topic_0128036887_p1811419441550">POST /v1.0/{project_id}/instances/{instance_id}/topics/delete</p>
|
|
<p id="kafka-api-180614003__en-us_topic_0128036887_p41157441754"><a href="#kafka-api-180614003__en-us_topic_0128036887_table999074314516">Table 1</a> describes the parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180614003__en-us_topic_0128036887_table999074314516"></a><a name="en-us_topic_0128036887_table999074314516"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614003__en-us_topic_0128036887_table999074314516" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="kafka-api-180614003__en-us_topic_0128036887_row1611514441455"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.4.2.5.1.1"><p id="kafka-api-180614003__en-us_topic_0128036887_p121151744458">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.4.2.5.1.2"><p id="kafka-api-180614003__en-us_topic_0128036887_p7115114415513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.4.2.5.1.3"><p id="kafka-api-180614003__en-us_topic_0128036887_p111517441957">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.3.4.2.5.1.4"><p id="kafka-api-180614003__en-us_topic_0128036887_p6115174418512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180614003__en-us_topic_0128036887_row121155447517"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p15115944853">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p17115244354">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p161154441252">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614003__en-us_topic_0128036887_p8115134420510">Indicates the ID of a project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180614003__en-us_topic_0128036887_row171159441358"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.4.2.5.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p12117204415518">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.4.2.5.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p411717442510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.4.2.5.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p111784412519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.3.4.2.5.1.4 "><p id="kafka-api-180614003__en-us_topic_0128036887_p1911784411513">Indicates the instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="kafka-api-180614003__en-us_topic_0128036887_section101441458"><h4 class="sectiontitle">Request</h4><p id="kafka-api-180614003__en-us_topic_0128036887_p1911710441056"><strong id="kafka-api-180614003__en-us_topic_0128036887_b17465174172820">Request parameters</strong></p>
|
|
<p id="kafka-api-180614003__en-us_topic_0128036887_p1111911449519"><a href="#kafka-api-180614003__en-us_topic_0128036887_table192144257">Table 2</a> describes the parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180614003__en-us_topic_0128036887_table192144257"></a><a name="en-us_topic_0128036887_table192144257"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614003__en-us_topic_0128036887_table192144257" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="kafka-api-180614003__en-us_topic_0128036887_row141190441157"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.4.2.5.1.1"><p id="kafka-api-180614003__en-us_topic_0128036887_p11191144155">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="kafka-api-180614003__en-us_topic_0128036887_p61195448514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.2.5.1.3"><p id="kafka-api-180614003__en-us_topic_0128036887_p11119104414518">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.4.2.5.1.4"><p id="kafka-api-180614003__en-us_topic_0128036887_p111915441953">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180614003__en-us_topic_0128036887_row1911984410515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.4.2.5.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p8119154410515">topics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p5119154417519">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.5.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p51191544556">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="kafka-api-180614003__en-us_topic_0128036887_p51191844655">Indicates the list of topics to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180614003__en-us_topic_0128036887_p13119544052"><strong id="kafka-api-180614003__en-us_topic_0128036887_b01535179288">Example request</strong></p>
|
|
<pre class="screen" id="kafka-api-180614003__en-us_topic_0128036887_screen181194447510">POST https://{dms_endpoint}/v1.0/{project_id}/instances/{instance_id}/topics/delete
|
|
{
|
|
"topics" : ["hah", "aabb"]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180614003__en-us_topic_0128036887_section19101644156"><h4 class="sectiontitle">Response</h4><p id="kafka-api-180614003__en-us_topic_0128036887_p15119154410510"><strong id="kafka-api-180614003__en-us_topic_0128036887_b167572752820">Response parameters</strong></p>
|
|
<p id="kafka-api-180614003__en-us_topic_0128036887_p1911924412513"><a href="#kafka-api-180614003__en-us_topic_0128036887_table10111744455">Table 3</a> describes the parameter.</p>
|
|
|
|
<div class="tablenoborder"><a name="kafka-api-180614003__en-us_topic_0128036887_table10111744455"></a><a name="en-us_topic_0128036887_table10111744455"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614003__en-us_topic_0128036887_table10111744455" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="kafka-api-180614003__en-us_topic_0128036887_row41192441858"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.4.2.4.1.1"><p id="kafka-api-180614003__en-us_topic_0128036887_p121201944354">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.4.2.4.1.2"><p id="kafka-api-180614003__en-us_topic_0128036887_p1812011441515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.4.2.4.1.3"><p id="kafka-api-180614003__en-us_topic_0128036887_p51207446518">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180614003__en-us_topic_0128036887_row15120184418519"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.4.2.4.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p1112013442053">topics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.4.2.4.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p1812019441651">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.4.2.4.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p10120244959">Indicates the list of topics.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614003__en-us_topic_0128036887_table046213306109" frame="border" border="1" rules="all"><caption><b>Table 4 </b>topics parameter description</caption><thead align="left"><tr id="kafka-api-180614003__en-us_topic_0128036887_row2046612306104"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.5.5.2.4.1.1"><p id="kafka-api-180614003__en-us_topic_0128036887_p1646783041010">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.220000000000002%" id="mcps1.3.5.5.2.4.1.2"><p id="kafka-api-180614003__en-us_topic_0128036887_p9468113091015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.55%" id="mcps1.3.5.5.2.4.1.3"><p id="kafka-api-180614003__en-us_topic_0128036887_p1846903011104">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180614003__en-us_topic_0128036887_row64765308104"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p347823071014">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p15479730111010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p848023015100">Indicates the topic name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="kafka-api-180614003__en-us_topic_0128036887_row248183016109"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.5.5.2.4.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p19482163018103">success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.220000000000002%" headers="mcps1.3.5.5.2.4.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p3483153041011">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.55%" headers="mcps1.3.5.5.2.4.1.3 "><p id="kafka-api-180614003__en-us_topic_0128036887_p1348413061012">Indicates whether the topics are deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="kafka-api-180614003__en-us_topic_0128036887_p31205440520"><strong id="kafka-api-180614003__en-us_topic_0128036887_b6976195332812">Example response</strong></p>
|
|
<pre class="screen" id="kafka-api-180614003__en-us_topic_0128036887_screen1122716406915">{
|
|
"topics" : [{
|
|
"id" : "haha",
|
|
"success" : true
|
|
}, {
|
|
"id" : "aabb",
|
|
"success" : true
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="kafka-api-180614003__en-us_topic_0128036887_section92216442511"><h4 class="sectiontitle">Status Code</h4><p id="kafka-api-180614003__en-us_topic_0128036887_p312020442057"><a href="#kafka-api-180614003__en-us_topic_0128036887_table6231844656">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-180614003__en-us_topic_0128036887_table6231844656"></a><a name="en-us_topic_0128036887_table6231844656"></a><table cellpadding="4" cellspacing="0" summary="" id="kafka-api-180614003__en-us_topic_0128036887_table6231844656" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="kafka-api-180614003__en-us_topic_0128036887_row1512019448511"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.6.3.2.3.1.1"><p id="kafka-api-180614003__en-us_topic_0128036887_p1120144453">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-180614003__en-us_topic_0128036887_p2012019445514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="kafka-api-180614003__en-us_topic_0128036887_row912012447517"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.6.3.2.3.1.1 "><p id="kafka-api-180614003__en-us_topic_0128036887_p912044411514">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.85000000000001%" headers="mcps1.3.6.3.2.3.1.2 "><p id="kafka-api-180614003__en-us_topic_0128036887_p71201441758">The topics are successfully deleted.</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>
|
|
|