yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
ae9af811a2b20ca4159a3bbea5c9c4cf90085dbf
doc-exports/docs/dcs/api-ref/DeleteHotkeyScanTask.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

447 lines
34 KiB
HTML
Raw Blame History

<a name="DeleteHotkeyScanTask"></a><a name="DeleteHotkeyScanTask"></a>
<h1 class="topictitle1">Deleting a Hot Key Analysis Task</h1>
<div id="body1708331107508"><div class="section" id="DeleteHotkeyScanTask__section19505719142215"><h4 class="sectiontitle">Function</h4><p id="DeleteHotkeyScanTask__p18506121962214">This API is used to delete a hot key analysis task.</p>
</div>
<div class="section" id="DeleteHotkeyScanTask__section4509111972210"><h4 class="sectiontitle">URI</h4><p id="DeleteHotkeyScanTask__p14510919202212">DELETE /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__table12513201918225" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row12511181932218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteHotkeyScanTask__p1651471912217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteHotkeyScanTask__p651581916226">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteHotkeyScanTask__p115161319192211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteHotkeyScanTask__p751771916223">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row751114198226"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteHotkeyScanTask__p8519101914228">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteHotkeyScanTask__p5520131913229">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteHotkeyScanTask__p20521151913229">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteHotkeyScanTask__p8524161992216">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row751111913222"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteHotkeyScanTask__p452571982215">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteHotkeyScanTask__p3527919172220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteHotkeyScanTask__p18528219182214">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteHotkeyScanTask__p2530201917224">Instance ID.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row1451131915221"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteHotkeyScanTask__p125311196225">hotkey_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteHotkeyScanTask__p1053261911229">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteHotkeyScanTask__p1353311922216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteHotkeyScanTask__p453521992219">ID of the hot key analysis task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHotkeyScanTask__section11537101962211"><h4 class="sectiontitle">Request Parameters</h4><p id="DeleteHotkeyScanTask__p15399198221">None</p>
</div>
<div class="section" id="DeleteHotkeyScanTask__section1954215190226"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteHotkeyScanTask__p11543171917229"><strong id="DeleteHotkeyScanTask__b8544119132210">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__response_HotkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row19545819122219"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteHotkeyScanTask__p16550019122212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteHotkeyScanTask__p10552121913222">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteHotkeyScanTask__p205531919172216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row954551915224"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p13555191962210">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p8556619102216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p455817191224">Hot key analysis record ID.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row1554520192224"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p135591119142217">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p125601919182218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p1756211194226">Instance ID.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row754551942217"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p556391922211">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p4565819122217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p1756751911223">Analysis task status. Value range:</p>
<ul id="DeleteHotkeyScanTask__ul06615281148"><li id="DeleteHotkeyScanTask__li12661202831415"><strong id="DeleteHotkeyScanTask__b916914312216">waiting</strong></li><li id="DeleteHotkeyScanTask__li366112851416"><strong id="DeleteHotkeyScanTask__b31701831132116">running</strong></li><li id="DeleteHotkeyScanTask__li1966218281148"><strong id="DeleteHotkeyScanTask__b1170731132118">success</strong></li><li id="DeleteHotkeyScanTask__li26621928151411"><strong id="DeleteHotkeyScanTask__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row2054591911226"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p4568151942210">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p10569219102214">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p557191919220">Analysis method. Value range:</p>
<ul id="DeleteHotkeyScanTask__ul33881240111911"><li id="DeleteHotkeyScanTask__li83881540121913"><strong id="DeleteHotkeyScanTask__b4602204710204">manual</strong></li><li id="DeleteHotkeyScanTask__li19388144031918"><strong id="DeleteHotkeyScanTask__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row1154521912211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p14572519162217">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p19573141919226">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p657541914229">Time when an analysis task is created. The format is <strong id="DeleteHotkeyScanTask__b95752019132213">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row754513195221"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p9576419152218">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p857841962220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p11579019172215">Time when an analysis task started. The format is <strong id="DeleteHotkeyScanTask__b2580121916223">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="DeleteHotkeyScanTask__b7580719132210">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row2546101932213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p858110192224">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p20582719162218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p9584171912212">Time when an analysis task ended. The format is <strong id="DeleteHotkeyScanTask__b1858571942211">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="DeleteHotkeyScanTask__b10585819192211">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row154651932212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p5585719182215">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p155873191225">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p258814193222">Number of hot keys.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row05461519132210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteHotkeyScanTask__p158912199227">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteHotkeyScanTask__p17591201916222">Array of <a href="#DeleteHotkeyScanTask__response_HotkeysBody">HotkeysBody</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteHotkeyScanTask__p18592019152219">Hot key record. (The value is <strong id="DeleteHotkeyScanTask__b1759314195222">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteHotkeyScanTask__response_HotkeysBody"></a><a name="response_HotkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__response_HotkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>HotkeysBody</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row3594019172218"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteHotkeyScanTask__p6596319152218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteHotkeyScanTask__p7598121919227">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteHotkeyScanTask__p2059911192228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row105941919142219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p1960117197221">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p26021419162220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p8603319182216">Key name.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row55941119162218"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p146041019132212">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p14606141982218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p86071193226">Key type. Value range:</p>
<ul id="DeleteHotkeyScanTask__ul196681728141413"><li id="DeleteHotkeyScanTask__li176681328111416"><strong id="DeleteHotkeyScanTask__b0636218204">string</strong></li><li id="DeleteHotkeyScanTask__li166842814146"><strong id="DeleteHotkeyScanTask__b29759813202">list</strong></li><li id="DeleteHotkeyScanTask__li18668192891410"><strong id="DeleteHotkeyScanTask__b1872311102011">set</strong></li><li id="DeleteHotkeyScanTask__li1666892813141"><strong id="DeleteHotkeyScanTask__b113281314172016">zset</strong></li><li id="DeleteHotkeyScanTask__li76681028121412"><strong id="DeleteHotkeyScanTask__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row125943191222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p17609141962213">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p16108197223">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p961141942214">Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="DeleteHotkeyScanTask__b20613161942213">ip:port</strong>.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row14594121915225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p5614111916220">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p186151919172218">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p2061710198228">Database where a hot key is located.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row105948198225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p206187195223">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1661931952210">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p14620111911221">Size of the key value.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row85941119102218"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p18622111932212">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1623819162217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p126251919142213">Key unit. <strong id="DeleteHotkeyScanTask__b1562515194224">count</strong>: number of keys; <strong id="DeleteHotkeyScanTask__b20625161982213">byte</strong>: key size.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row8594019102211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteHotkeyScanTask__p7626119182213">freq</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1462811972217">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteHotkeyScanTask__p15629151914221">Reflects the access frequency of a key within a specific period of time.</p>
<p id="DeleteHotkeyScanTask__p863111196221">The value is the logarithmic access frequency counter. The maximum value is <strong id="DeleteHotkeyScanTask__b26322196222">255</strong>, which indicates 1 million access requests. After the frequency reaches <strong id="DeleteHotkeyScanTask__b166321719172216">255</strong>, the value will no longer increase even if access requests continue to increase. The value will decrease by <strong id="DeleteHotkeyScanTask__b563211942210">1</strong> for every minute during which the key is not accessed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteHotkeyScanTask__p5633151962217"><strong id="DeleteHotkeyScanTask__b7633181911226">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row14634519172212"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteHotkeyScanTask__p2636171920229">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteHotkeyScanTask__p126372191220">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteHotkeyScanTask__p7638131982212">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row963461910224"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteHotkeyScanTask__p9640141917221">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteHotkeyScanTask__p064151910221">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteHotkeyScanTask__p166421519142217">Error message.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row7634131914227"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteHotkeyScanTask__p164461962211">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteHotkeyScanTask__p9645131972214">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteHotkeyScanTask__p166462198224">Error code.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row263471982219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteHotkeyScanTask__p664831952214">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteHotkeyScanTask__p16649161917228">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteHotkeyScanTask__p86501719102217">Extended error information. This parameter is not used currently and is set to <strong id="DeleteHotkeyScanTask__b196517198226">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteHotkeyScanTask__p176521819112219"><strong id="DeleteHotkeyScanTask__b3652819132215">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__table176521519142218" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row66531519132215"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="DeleteHotkeyScanTask__p1665571972216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="DeleteHotkeyScanTask__p56561619172210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="DeleteHotkeyScanTask__p5657171902213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row19653141918225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteHotkeyScanTask__p20659121912229">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteHotkeyScanTask__p36601319142220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteHotkeyScanTask__p196617195227">Error message.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row3653161912214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteHotkeyScanTask__p1866317197225">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1066412194221">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteHotkeyScanTask__p666541910222">Error code.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row156531219112210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteHotkeyScanTask__p8666131992211">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteHotkeyScanTask__p18667141982211">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteHotkeyScanTask__p16669141962214">Extended error information. This parameter is not used currently and is set to <strong id="DeleteHotkeyScanTask__b16669119182213">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteHotkeyScanTask__p196701319162211"><strong id="DeleteHotkeyScanTask__b6671161982217">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__table16711119152220" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row1967311198227"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="DeleteHotkeyScanTask__p19675101972212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="DeleteHotkeyScanTask__p1167661914220">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="DeleteHotkeyScanTask__p4678121917222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row667317191225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteHotkeyScanTask__p3679151918226">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteHotkeyScanTask__p146801919102216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteHotkeyScanTask__p19681161992217">Error message.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row16673719142215"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteHotkeyScanTask__p11682219112215">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1068441972219">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteHotkeyScanTask__p9685141932213">Error code.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row26733198229"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteHotkeyScanTask__p4686101919220">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteHotkeyScanTask__p176875196228">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteHotkeyScanTask__p56893191229">Extended error information. This parameter is not used currently and is set to <strong id="DeleteHotkeyScanTask__b8690419102215">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteHotkeyScanTask__p17690111902218"><strong id="DeleteHotkeyScanTask__b116911219162215">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__table16692319122216" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row1169219199226"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="DeleteHotkeyScanTask__p14695219182217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="DeleteHotkeyScanTask__p1769651916229">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="DeleteHotkeyScanTask__p1369731972210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row1269221942216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteHotkeyScanTask__p136991319112213">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteHotkeyScanTask__p16700201982212">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteHotkeyScanTask__p12701419192215">Error message.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row1569217190225"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteHotkeyScanTask__p13703319102219">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteHotkeyScanTask__p570451992216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteHotkeyScanTask__p5706111942211">Error code.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row4692141952219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteHotkeyScanTask__p12708141912221">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteHotkeyScanTask__p270912191226">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteHotkeyScanTask__p117111919132220">Extended error information. This parameter is not used currently and is set to <strong id="DeleteHotkeyScanTask__b17124198225">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteHotkeyScanTask__p97135195222"><strong id="DeleteHotkeyScanTask__b1371491972217">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__table671431920223" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="DeleteHotkeyScanTask__row9714151952212"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="DeleteHotkeyScanTask__p6716171910222">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="DeleteHotkeyScanTask__p371831911224">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="DeleteHotkeyScanTask__p177194190221">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row071413196229"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteHotkeyScanTask__p7720131932218">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteHotkeyScanTask__p6721519182218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteHotkeyScanTask__p17722119132219">Error message.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row11714121915226"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteHotkeyScanTask__p4724319202212">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteHotkeyScanTask__p1472641922218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteHotkeyScanTask__p167275191228">Error code.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row11714619122220"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteHotkeyScanTask__p18728219132219">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteHotkeyScanTask__p5730111916221">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteHotkeyScanTask__p1073118191226">Extended error information. This parameter is not used currently and is set to <strong id="DeleteHotkeyScanTask__b1173231919222">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHotkeyScanTask__section167321919142210"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="DeleteHotkeyScanTask__screen207341319152213">DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371</pre>
</div>
<div class="section" id="DeleteHotkeyScanTask__section073621911220"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteHotkeyScanTask__p4737219162215"><strong id="DeleteHotkeyScanTask__b157381019192215">Status code: 200</strong></p>
<p id="DeleteHotkeyScanTask__p1073801992212">Hot key analysis record deleted.</p>
<pre class="screen" id="DeleteHotkeyScanTask__screen147421619162210">{
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"status" : "success",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z",
"started_at" : "2020-06-15T02:21:23.534Z",
"finished_at" : "2020-06-15T02:21:25.588Z",
"keys" : [ {
"name" : "dcs-hotkey-test",
"type" : "string",
"shard" : "192.168.1.134:6379",
"db" : 0,
"size" : 3000,
"unit" : "byte",
"freq" : 4
} ]
}</pre>
<p id="DeleteHotkeyScanTask__p17761101913222"><strong id="DeleteHotkeyScanTask__b177625195224">Status code: 400</strong></p>
<p id="DeleteHotkeyScanTask__p1762181914223">Invalid request.</p>
<pre class="screen" id="DeleteHotkeyScanTask__screen57641819102216">{
"error_code" : "DCS.4922",
"error_msg" : "Does not support hotkey analyze."
}</pre>
</div>
<div class="section" id="DeleteHotkeyScanTask__section12768619152217"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHotkeyScanTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteHotkeyScanTask__row476951942213"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteHotkeyScanTask__p877120194226">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteHotkeyScanTask__p1377301915229">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHotkeyScanTask__row12770519142217"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p18774181922215">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p37751119172212">Hot key analysis record deleted.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row3770161918223"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p4777141918225">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p589541982217">Hot key analysis record not found.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row677031992215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p158958192225">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p589631910227">Invalid request.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row127708198221"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p189712198222">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p2089719194227">Invalid authentication information.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row17770119192215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p18897181972217">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p11898181918224">The request is rejected.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row17701419132215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p13898161914228">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p17899121914225">The requested resource is not found.</p>
</td>
</tr>
<tr id="DeleteHotkeyScanTask__row16770919152210"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHotkeyScanTask__p139007198229">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHotkeyScanTask__p79011191228">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHotkeyScanTask__section1690213195225"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteHotkeyScanTask__p890317195227">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="CacheAnalysisManagement.html">Cache Analysis</a></div>
</div>
</div>
View Git Blame Copy Permalink