yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
e21aa18fe10074b030806761817558444e26f6c3
doc-exports/docs/dcs/api-ref/DeleteBigkeyScanTask.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

438 lines
33 KiB
HTML
Raw Blame History

<a name="DeleteBigkeyScanTask"></a><a name="DeleteBigkeyScanTask"></a>
<h1 class="topictitle1">Deleting a Big Key Analysis Task</h1>
<div id="body1708331107508"><div class="section" id="DeleteBigkeyScanTask__section58981853156"><h4 class="sectiontitle">Function</h4><p id="DeleteBigkeyScanTask__p389812518153">This API is used to delete a big key analysis task.</p>
</div>
<div class="section" id="DeleteBigkeyScanTask__section2898145121514"><h4 class="sectiontitle">URI</h4><p id="DeleteBigkeyScanTask__p18983513151">DELETE /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__table58997541512" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row389935141514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteBigkeyScanTask__p198991561517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteBigkeyScanTask__p1189914591510">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteBigkeyScanTask__p7899155159">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteBigkeyScanTask__p389910561513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row168993515159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteBigkeyScanTask__p3899145191514">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteBigkeyScanTask__p78998511520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteBigkeyScanTask__p118991514151">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteBigkeyScanTask__p138994571511">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row198996518157"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteBigkeyScanTask__p168994531519">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteBigkeyScanTask__p168991750156">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteBigkeyScanTask__p989912551514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteBigkeyScanTask__p1489913520157">Instance ID.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1889920541515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteBigkeyScanTask__p98999591519">bigkey_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteBigkeyScanTask__p7899185131517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteBigkeyScanTask__p129009541512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteBigkeyScanTask__p179007518159">ID of the big key analysis task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBigkeyScanTask__section1290014591517"><h4 class="sectiontitle">Request Parameters</h4><p id="DeleteBigkeyScanTask__p790095141517">None</p>
</div>
<div class="section" id="DeleteBigkeyScanTask__section189001958157"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteBigkeyScanTask__p890045161512"><strong id="DeleteBigkeyScanTask__b1690012512155">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__response_BigkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row69009541519"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="DeleteBigkeyScanTask__p190135141511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="DeleteBigkeyScanTask__p99011857156">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="DeleteBigkeyScanTask__p19015501513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row79007591515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p490112510154">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p10901857153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p590110521510">Big key analysis record ID.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1090016518157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p109016519152">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p149011510150">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p1901165181513">Instance ID.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row39002531515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p390114515153">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p209019581520">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p13901125111518">Analysis task status. Value range:</p>
<ul id="DeleteBigkeyScanTask__ul06615281148"><li id="DeleteBigkeyScanTask__li12661202831415"><strong id="DeleteBigkeyScanTask__b916914312216">waiting</strong></li><li id="DeleteBigkeyScanTask__li366112851416"><strong id="DeleteBigkeyScanTask__b31701831132116">running</strong></li><li id="DeleteBigkeyScanTask__li1966218281148"><strong id="DeleteBigkeyScanTask__b1170731132118">success</strong></li><li id="DeleteBigkeyScanTask__li26621928151411"><strong id="DeleteBigkeyScanTask__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row590018541515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1190115531516">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p1790118531515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p99011657153">Analysis method. Value range:</p>
<ul id="DeleteBigkeyScanTask__ul33881240111911"><li id="DeleteBigkeyScanTask__li83881540121913"><strong id="DeleteBigkeyScanTask__b4602204710204">manual</strong></li><li id="DeleteBigkeyScanTask__li19388144031918"><strong id="DeleteBigkeyScanTask__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row290095191519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1901056159">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p490125171515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p8901958152">Time when an analysis task is created. The format is <strong id="DeleteBigkeyScanTask__b1290112514152">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row11900195191516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p3902175191511">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p090218516153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p79023517156">Time when an analysis task started. The format is <strong id="DeleteBigkeyScanTask__b129021656152">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="DeleteBigkeyScanTask__b109021519155">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row19901135161511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p189021052153">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p139026514154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p69023520156">Time when an analysis task ended. The format is <strong id="DeleteBigkeyScanTask__b19902125131515">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="DeleteBigkeyScanTask__b99021571511">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1290115131511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1490217517152">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p7902115131519">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p89022521520">Number of big keys.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row159019515152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="DeleteBigkeyScanTask__p69024541517">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="DeleteBigkeyScanTask__p490218513159">Array of <a href="#DeleteBigkeyScanTask__response_BigkeysBody">BigkeysBody</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="DeleteBigkeyScanTask__p119027514158">Big key record. (The value is <strong id="DeleteBigkeyScanTask__b190210511156">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="DeleteBigkeyScanTask__response_BigkeysBody"></a><a name="response_BigkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__response_BigkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>BigkeysBody</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row690213511513"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="DeleteBigkeyScanTask__p29026511158">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="DeleteBigkeyScanTask__p1590218515155">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="DeleteBigkeyScanTask__p990316510153">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row990265161510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1890318511518">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p199031350157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p490312561519">Key name.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row109022510154"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p139031521511">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p1290315561511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p12903105141517">Key type. Value range:</p>
<ul id="DeleteBigkeyScanTask__ul196681728141413"><li id="DeleteBigkeyScanTask__li176681328111416"><strong id="DeleteBigkeyScanTask__b0636218204">string</strong></li><li id="DeleteBigkeyScanTask__li166842814146"><strong id="DeleteBigkeyScanTask__b29759813202">list</strong></li><li id="DeleteBigkeyScanTask__li18668192891410"><strong id="DeleteBigkeyScanTask__b1872311102011">set</strong></li><li id="DeleteBigkeyScanTask__li1666892813141"><strong id="DeleteBigkeyScanTask__b113281314172016">zset</strong></li><li id="DeleteBigkeyScanTask__li76681028121412"><strong id="DeleteBigkeyScanTask__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row12902256152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1690365161513">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p990315511152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p59038513153">Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="DeleteBigkeyScanTask__b20903552154">ip:port</strong>.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1790265181519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p49039515150">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p1490315161510">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p6903451154">Database where a big key is located.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row5902755159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p59035591519">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p49030591513">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p79031457153">Size of the key value.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row490215513155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="DeleteBigkeyScanTask__p290310581516">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="DeleteBigkeyScanTask__p390313512158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="DeleteBigkeyScanTask__p2090319591519">Key unit. <strong id="DeleteBigkeyScanTask__b5903115151512">count</strong>: number of keys; <strong id="DeleteBigkeyScanTask__b1590311511515">byte</strong>: key size.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteBigkeyScanTask__p29032511515"><strong id="DeleteBigkeyScanTask__b19903175131514">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row390314520158"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="DeleteBigkeyScanTask__p15904125171513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="DeleteBigkeyScanTask__p690485101519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="DeleteBigkeyScanTask__p2904195131514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row129031051152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteBigkeyScanTask__p59041855156">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteBigkeyScanTask__p090414531518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteBigkeyScanTask__p89049517154">Error message.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row8903754153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteBigkeyScanTask__p10904105191519">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteBigkeyScanTask__p10904135151515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteBigkeyScanTask__p179049541511">Error code.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1390414513159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="DeleteBigkeyScanTask__p79047512156">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="DeleteBigkeyScanTask__p1590435111519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="DeleteBigkeyScanTask__p890410513158">Extended error information. This parameter is not used currently and is set to <strong id="DeleteBigkeyScanTask__b990445111512">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteBigkeyScanTask__p119043531514"><strong id="DeleteBigkeyScanTask__b1190465101510">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__table189047551516" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row119047551510"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="DeleteBigkeyScanTask__p7905656153">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="DeleteBigkeyScanTask__p159053531516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="DeleteBigkeyScanTask__p2905552158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row1290445161515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteBigkeyScanTask__p129057541517">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteBigkeyScanTask__p290518516157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteBigkeyScanTask__p189052511159">Error message.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row14904155141510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1390565131512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteBigkeyScanTask__p99051152151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteBigkeyScanTask__p290516515154">Error code.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1790418519157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="DeleteBigkeyScanTask__p19050511513">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="DeleteBigkeyScanTask__p13905175171514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="DeleteBigkeyScanTask__p89051057152">Extended error information. This parameter is not used currently and is set to <strong id="DeleteBigkeyScanTask__b189052591518">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteBigkeyScanTask__p2905555152"><strong id="DeleteBigkeyScanTask__b9905135171513">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__table13905155191516" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row119051512152"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="DeleteBigkeyScanTask__p59056511152">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="DeleteBigkeyScanTask__p3905105141520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="DeleteBigkeyScanTask__p1090514511159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row11905851157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteBigkeyScanTask__p79066518152">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteBigkeyScanTask__p12906145161512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteBigkeyScanTask__p190617571514">Error message.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row39059561511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteBigkeyScanTask__p129061519152">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteBigkeyScanTask__p690613513155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteBigkeyScanTask__p189061515155">Error code.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row10905454156"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="DeleteBigkeyScanTask__p119068513157">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="DeleteBigkeyScanTask__p990612513158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="DeleteBigkeyScanTask__p3906105171517">Extended error information. This parameter is not used currently and is set to <strong id="DeleteBigkeyScanTask__b1190675141517">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteBigkeyScanTask__p159061751156"><strong id="DeleteBigkeyScanTask__b20906115121514">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__table490645131510" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row99065581511"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="DeleteBigkeyScanTask__p10906125161515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="DeleteBigkeyScanTask__p18906195171518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="DeleteBigkeyScanTask__p790617531513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row7906195161517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteBigkeyScanTask__p59063551512">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteBigkeyScanTask__p690655171516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteBigkeyScanTask__p390615513151">Error message.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row129069561511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1190635191518">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteBigkeyScanTask__p69069561518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteBigkeyScanTask__p1907155181510">Error code.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row11906185141516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="DeleteBigkeyScanTask__p17907859151">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="DeleteBigkeyScanTask__p1790765121512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="DeleteBigkeyScanTask__p990719581511">Extended error information. This parameter is not used currently and is set to <strong id="DeleteBigkeyScanTask__b129072561514">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="DeleteBigkeyScanTask__p159072517154"><strong id="DeleteBigkeyScanTask__b139071052157">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__table2090725151515" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="DeleteBigkeyScanTask__row12907554152"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="DeleteBigkeyScanTask__p1990718551510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="DeleteBigkeyScanTask__p1390765191519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="DeleteBigkeyScanTask__p1790710551517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row15907195191511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteBigkeyScanTask__p69078581511">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteBigkeyScanTask__p99071531517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteBigkeyScanTask__p15907257152">Error message.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row9907155151510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteBigkeyScanTask__p1190714541515">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteBigkeyScanTask__p2907455151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteBigkeyScanTask__p19907758151">Error code.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row89075518153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="DeleteBigkeyScanTask__p19907165191519">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="DeleteBigkeyScanTask__p990715541519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="DeleteBigkeyScanTask__p1990855151515">Extended error information. This parameter is not used currently and is set to <strong id="DeleteBigkeyScanTask__b1690815571518">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBigkeyScanTask__section99081353158"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="DeleteBigkeyScanTask__screen1390895191514">DELETE https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task/858ee14c-2271-4489-8b82-7bda7459ae3e</pre>
</div>
<div class="section" id="DeleteBigkeyScanTask__section129080515154"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteBigkeyScanTask__p12908165111515"><strong id="DeleteBigkeyScanTask__b139081953153">Status code: 200</strong></p>
<p id="DeleteBigkeyScanTask__p290816541517">Big key analysis task deleted successfully.</p>
<pre class="screen" id="DeleteBigkeyScanTask__screen09086519152">{
"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-bigkey-test",
"type" : "string",
"shard" : "192.168.1.134:6379",
"db" : 0,
"size" : 3000,
"unit" : "byte"
} ]
}</pre>
<p id="DeleteBigkeyScanTask__p159088511153"><strong id="DeleteBigkeyScanTask__b129082513157">Status code: 400</strong></p>
<p id="DeleteBigkeyScanTask__p1090855161518">Invalid request.</p>
<pre class="screen" id="DeleteBigkeyScanTask__screen14909458157">{
"error_code" : "DCS.4919",
"error_msg" : "Does not support bigkey analyze."
}</pre>
</div>
<div class="section" id="DeleteBigkeyScanTask__section159093513159"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteBigkeyScanTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteBigkeyScanTask__row590985161519"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteBigkeyScanTask__p390935151517">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteBigkeyScanTask__p39091354156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteBigkeyScanTask__row10909185131511"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p29094581520">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p99097591513">Big key analysis task deleted successfully.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row6909359155"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p1190915511516">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p1490916519151">No big key analysis tasks deleted.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row89091351154"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p179091052153">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p169096581517">Invalid request.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row9909352156"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p59091052156">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p11909457152">Invalid authentication information.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row290920518157"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p149414619150">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p209410610156">The request is rejected.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row1290935201519"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p39416619152">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p294146121518">The requested resource is not found.</p>
</td>
</tr>
<tr id="DeleteBigkeyScanTask__row2909155201518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteBigkeyScanTask__p89411619151">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteBigkeyScanTask__p99410681518">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteBigkeyScanTask__section139415681520"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteBigkeyScanTask__p594465159">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