forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
121 lines
10 KiB
HTML
121 lines
10 KiB
HTML
<a name="dli_02_0195"></a><a name="dli_02_0195"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Queue</h1>
|
|
<div id="body1566551543147"><div class="section" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_en-us_topic_0042904513-chtext"><h4 class="sectiontitle">Function</h4><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p66842817">This API is used to delete a specified queue.</p>
|
|
<div class="note" id="dli_02_0195__note298869483249"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0195__p2689825283249">If a task is being executed in a specified queue, the queue cannot be deleted.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_section5968939"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_ul45559064"><li id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_li7378398">URI format<p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p66405588"><a name="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_li7378398"></a><a name="en-us_topic_0069078609_en-us_topic_0069077803_li7378398"></a>DELETE /v1.0/{project_id}/queues/{queue_name}</p>
|
|
</li><li id="dli_02_0195__en-us_topic_0069078609_li1725612218454">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="14.299999999999999%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p17730125817424">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.89%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.089999999999998%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0195__p15777194115412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.72%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p12730358114211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0195__en-us_topic_0069078609_row492426174015"><td class="cellrowborder" valign="top" width="14.299999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0195__en-us_topic_0069078609_p136251677400">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.89%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0195__en-us_topic_0069078609_p136278719407">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.089999999999998%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0195__p157776413546">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.72%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0195__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="14.299999999999999%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p43412436">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.89%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.089999999999998%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0195__p17777164117543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.72%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p18974100">Name of a queue to be deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_section53720453"><h4 class="sectiontitle">Request</h4><p id="dli_02_0195__p4954513815358">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_section13722030"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_table9875225" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_row58082174"><th align="left" class="cellrowborder" valign="top" width="14.799999999999999%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p125621631174817">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.46%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0195__p1970853743716">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.629999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p656273174812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.11%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p8562331154812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_row37593218"><td class="cellrowborder" valign="top" width="14.799999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p25151854">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0195__p57080376378">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.629999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p618145">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.11%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p50069818">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0195__parmvalue4993877595041"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_row47975183"><td class="cellrowborder" valign="top" width="14.799999999999999%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p60784581">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.46%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0195__p270893719378">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.629999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p46769243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.11%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_p3352142617584">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__section15772143623410"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0195__p534664283414">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__section59635464345"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0195__en-us_topic_0069078609_en-us_topic_0069077803_screen64745266">{
|
|
"is_success": true,
|
|
"message": ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0195__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0195__tb12870f1c5f24b27abd55ca24264af36">Table 3</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0195__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0195__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0195__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0195__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0195__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0195__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0195__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0195__p104431642124811">Deletion succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0195__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0195__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0195__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0195__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0195__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0195__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0195__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0195__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0193.html">Queue-related APIs (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|