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

433 lines
34 KiB
HTML
Raw Blame History

<a name="ShowBigkeyScanTaskDetails"></a><a name="ShowBigkeyScanTaskDetails"></a>
<h1 class="topictitle1">Querying Big Key Analysis Details</h1>
<div id="body1708331107508"><div class="section" id="ShowBigkeyScanTaskDetails__section471617541515"><h4 class="sectiontitle">Function</h4><p id="ShowBigkeyScanTaskDetails__p7716145101518">This API is used to query the big key analysis details.</p>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section27169551512"><h4 class="sectiontitle">URI</h4><p id="ShowBigkeyScanTaskDetails__p157161552159">GET /v2/{project_id}/instances/{instance_id}/bigkey-task/{bigkey_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__table177177517158" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row4717135121519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowBigkeyScanTaskDetails__p37179513155">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowBigkeyScanTaskDetails__p47176561519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowBigkeyScanTaskDetails__p0717954155">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowBigkeyScanTaskDetails__p17171953154">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row1471712519158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowBigkeyScanTaskDetails__p17717115191512">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowBigkeyScanTaskDetails__p67173551512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowBigkeyScanTaskDetails__p147175516158">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowBigkeyScanTaskDetails__p771718510155">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row671711591512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowBigkeyScanTaskDetails__p157175541513">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowBigkeyScanTaskDetails__p271712519156">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowBigkeyScanTaskDetails__p1771715141518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowBigkeyScanTaskDetails__p157171517155">Instance ID.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row3717058159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowBigkeyScanTaskDetails__p1071817518156">bigkey_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowBigkeyScanTaskDetails__p207181456159">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowBigkeyScanTaskDetails__p107187531514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowBigkeyScanTaskDetails__p37184511510">ID of the big key analysis task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section1271817519155"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowBigkeyScanTaskDetails__p2718155141514">None</p>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section271918510154"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowBigkeyScanTaskDetails__p9719165111510"><strong id="ShowBigkeyScanTaskDetails__b1371918541515">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__response_BigkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row371919501517"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p471910517151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p13719105141519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p167197591514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row10719205201514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p471975101518">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p1171925141516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p67203513153">Big key analysis record ID.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row671975151515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p2072011515154">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p157209513158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1972085151519">Instance ID.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row4719854155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p572017581510">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p772045131518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p77209516159">Analysis task status. Value range:</p>
<ul id="ShowBigkeyScanTaskDetails__ul06615281148"><li id="ShowBigkeyScanTaskDetails__li12661202831415"><strong id="ShowBigkeyScanTaskDetails__b916914312216">waiting</strong></li><li id="ShowBigkeyScanTaskDetails__li366112851416"><strong id="ShowBigkeyScanTaskDetails__b31701831132116">running</strong></li><li id="ShowBigkeyScanTaskDetails__li1966218281148"><strong id="ShowBigkeyScanTaskDetails__b1170731132118">success</strong></li><li id="ShowBigkeyScanTaskDetails__li26621928151411"><strong id="ShowBigkeyScanTaskDetails__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row771911551519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p187201654158">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p177201758155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p97201052152">Analysis method. Value range:</p>
<ul id="ShowBigkeyScanTaskDetails__ul33881240111911"><li id="ShowBigkeyScanTaskDetails__li83881540121913"><strong id="ShowBigkeyScanTaskDetails__b4602204710204">manual</strong></li><li id="ShowBigkeyScanTaskDetails__li19388144031918"><strong id="ShowBigkeyScanTaskDetails__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row137191351150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p18720195161519">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p107201531510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p87209541514">Time when an analysis task is created. The format is <strong id="ShowBigkeyScanTaskDetails__b17201520158">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row18719145161517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p972012512153">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p12720125161519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p57208519158">Time when an analysis task started. The format is <strong id="ShowBigkeyScanTaskDetails__b272015515150">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="ShowBigkeyScanTaskDetails__b1372075151516">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row77192051153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p9720185141518">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p117207581515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p2072095181510">Time when an analysis task ended. The format is <strong id="ShowBigkeyScanTaskDetails__b187209511152">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="ShowBigkeyScanTaskDetails__b167208516159">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row1571919519151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p177203519159">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p872012514152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p18720854152">Number of big keys.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row20719358158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p187201157158">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p1772013516152">Array of <a href="#ShowBigkeyScanTaskDetails__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="ShowBigkeyScanTaskDetails__p37201514157">Big key record. (The value is <strong id="ShowBigkeyScanTaskDetails__b5721125191515">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowBigkeyScanTaskDetails__response_BigkeysBody"></a><a name="response_BigkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__response_BigkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>BigkeysBody</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row872110541520"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p11721165111510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p167213591516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p19721195181514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row1721853151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p17721145161515">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p472116551514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p37218551515">Key name.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row1872115141513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p1772113551517">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p472120510151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p472185171517">Key type. Value range:</p>
<ul id="ShowBigkeyScanTaskDetails__ul196681728141413"><li id="ShowBigkeyScanTaskDetails__li176681328111416"><strong id="ShowBigkeyScanTaskDetails__b0636218204">string</strong></li><li id="ShowBigkeyScanTaskDetails__li166842814146"><strong id="ShowBigkeyScanTaskDetails__b29759813202">list</strong></li><li id="ShowBigkeyScanTaskDetails__li18668192891410"><strong id="ShowBigkeyScanTaskDetails__b1872311102011">set</strong></li><li id="ShowBigkeyScanTaskDetails__li1666892813141"><strong id="ShowBigkeyScanTaskDetails__b113281314172016">zset</strong></li><li id="ShowBigkeyScanTaskDetails__li76681028121412"><strong id="ShowBigkeyScanTaskDetails__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row167219519152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p127211052152">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p1072113501511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p5721554155">Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="ShowBigkeyScanTaskDetails__b17211557159">ip:port</strong>.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row872155121510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p27217517157">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p8721158155">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1972175191519">Database where a big key is located.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row167211853156"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p187224571510">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p107228571512">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p17722125101518">Size of the key value.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row11721145161510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p1372265181510">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p972215141519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p137221655155">Key unit. <strong id="ShowBigkeyScanTaskDetails__b1572255181518">count</strong>: number of keys; <strong id="ShowBigkeyScanTaskDetails__b17722356151">byte</strong>: key size.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowBigkeyScanTaskDetails__p1972212519157"><strong id="ShowBigkeyScanTaskDetails__b1672219517156">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row1722135201514"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p472235101518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p77221950152">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p147228519157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row1722050159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p1672295141517">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p972210561512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p157225516155">Error message.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row27224591513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p1772212514150">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p77221053154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1172212591510">Error code.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row20722653153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p20722259158">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p57225518159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p87222518152">Extended error information. This parameter is not used currently and is set to <strong id="ShowBigkeyScanTaskDetails__b372365131512">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowBigkeyScanTaskDetails__p072310511152"><strong id="ShowBigkeyScanTaskDetails__b1872320516158">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__table772314571519" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row8723185191513"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p1572325101519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p5723145151510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p772355121517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row772316516155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p572316581518">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p127231659156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p17238514157">Error message.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row2072395101510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p117233519158">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p18723654156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p172395171513">Error code.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row107239521517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p167231553157">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p15723185201514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p7723195191519">Extended error information. This parameter is not used currently and is set to <strong id="ShowBigkeyScanTaskDetails__b187236513156">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowBigkeyScanTaskDetails__p6723115161519"><strong id="ShowBigkeyScanTaskDetails__b57231955158">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__table197231057157" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row17723459153"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p1472412521520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p1472410510157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p6724105131512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row187231353154"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p67245517156">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p3724950154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1372416517154">Error message.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row2723165111512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p472475111512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p87241358157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p117241519154">Error code.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row372413591518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p47245518159">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p672495181511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p97243501514">Extended error information. This parameter is not used currently and is set to <strong id="ShowBigkeyScanTaskDetails__b4724455151">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowBigkeyScanTaskDetails__p14724195191516"><strong id="ShowBigkeyScanTaskDetails__b157241358154">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__table117241259153" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row572455161517"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p1972465181519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p1472417520157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p107257520152">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row18724115101517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p1572518541511">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p1672511518154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1072517518156">Error message.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row572405101516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p12725352150">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p167253511153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1272510518151">Error code.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row672412571514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p177261851158">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p872616551516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p177263519159">Extended error information. This parameter is not used currently and is set to <strong id="ShowBigkeyScanTaskDetails__b372645161512">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowBigkeyScanTaskDetails__p1772617551516"><strong id="ShowBigkeyScanTaskDetails__b157265511520">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__table672619591518" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row972635131519"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ShowBigkeyScanTaskDetails__p772675111518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ShowBigkeyScanTaskDetails__p1672665181511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ShowBigkeyScanTaskDetails__p117265516158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row072614515155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p127261755159">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p1872695171511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p17266541519">Error message.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row2072613501511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p97261254155">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p5726195181512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p20726958155">Error code.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row8726051153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowBigkeyScanTaskDetails__p872612521518">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowBigkeyScanTaskDetails__p37271581514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowBigkeyScanTaskDetails__p1872715541517">Extended error information. This parameter is not used currently and is set to <strong id="ShowBigkeyScanTaskDetails__b14727155131519">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section37271059158"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowBigkeyScanTaskDetails__screen17727852159">GET 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="ShowBigkeyScanTaskDetails__section167276512154"><h4 class="sectiontitle">Example Responses</h4><p id="ShowBigkeyScanTaskDetails__p6727357158"><strong id="ShowBigkeyScanTaskDetails__b137278517155">Status code: 200</strong></p>
<p id="ShowBigkeyScanTaskDetails__p972718541520">Big key analysis details queried successfully.</p>
<pre class="screen" id="ShowBigkeyScanTaskDetails__screen07273591515">{
"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="ShowBigkeyScanTaskDetails__p172712514155"><strong id="ShowBigkeyScanTaskDetails__b1727195161516">Status code: 400</strong></p>
<p id="ShowBigkeyScanTaskDetails__p14727145181515">Invalid request.</p>
<pre class="screen" id="ShowBigkeyScanTaskDetails__screen57271552151">{
"error_code" : "DCS.4919",
"error_msg" : "Does not support bigkey analyze."
}</pre>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section5728158154"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBigkeyScanTaskDetails__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowBigkeyScanTaskDetails__row372811515158"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowBigkeyScanTaskDetails__p37283517156">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowBigkeyScanTaskDetails__p672814516152">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBigkeyScanTaskDetails__row147289561513"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p272805191512">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p1472812561517">Big key analysis details queried successfully.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row67286513156"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p272814513156">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p107283521512">Invalid request.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row147282520156"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p2072805161515">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p272875161510">Invalid authentication information.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row117285571512"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p1772810513156">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p1772820551510">The request is rejected.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row2072815501517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p184505131514">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p1184555101518">The requested resource is not found.</p>
</td>
</tr>
<tr id="ShowBigkeyScanTaskDetails__row772810521518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBigkeyScanTaskDetails__p11845115111516">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBigkeyScanTaskDetails__p158451254155">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBigkeyScanTaskDetails__section18451656156"><h4 class="sectiontitle">Error Codes</h4><p id="ShowBigkeyScanTaskDetails__p38451257153">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