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

424 lines
33 KiB
HTML
Raw Blame History

<a name="CreateHotkeyScanTask"></a><a name="CreateHotkeyScanTask"></a>
<h1 class="topictitle1">Creating a Hot Key Analysis Task</h1>
<div id="body1708331107508"><div class="section" id="CreateHotkeyScanTask__section210326161514"><h4 class="sectiontitle">Function</h4><p id="CreateHotkeyScanTask__p151032619154">This API is used to create a hot key analysis task.</p>
<p id="CreateHotkeyScanTask__p6103106111516">To perform hot key analysis, the instance's <strong id="CreateHotkeyScanTask__b10103964153">maxmemory-policy</strong> parameter must be set to <strong id="CreateHotkeyScanTask__b1710356101513">allkeys-lfu</strong> or <strong id="CreateHotkeyScanTask__b3103146111515">volatile-lfu</strong>.</p>
</div>
<div class="section" id="CreateHotkeyScanTask__section1410366201514"><h4 class="sectiontitle">URI</h4><p id="CreateHotkeyScanTask__p17103366158">POST /v2/{project_id}/instances/{instance_id}/hotkey-task</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__table61044614151" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row151049612159"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateHotkeyScanTask__p1110436191519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateHotkeyScanTask__p51045621512">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateHotkeyScanTask__p71041671514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateHotkeyScanTask__p410419691516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row510486151513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateHotkeyScanTask__p4104176131518">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateHotkeyScanTask__p1710415610155">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateHotkeyScanTask__p171041369154">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateHotkeyScanTask__p151049691518">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row10104196171511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateHotkeyScanTask__p1410436151513">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateHotkeyScanTask__p31041691520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateHotkeyScanTask__p9104196151519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateHotkeyScanTask__p151041363159">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateHotkeyScanTask__section191044661519"><h4 class="sectiontitle">Request Parameters</h4><p id="CreateHotkeyScanTask__p210406111518">None</p>
</div>
<div class="section" id="CreateHotkeyScanTask__section1010512617158"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateHotkeyScanTask__p31054611157"><strong id="CreateHotkeyScanTask__b6105176191517">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__response_HotkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row1110510612158"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateHotkeyScanTask__p1210506191510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateHotkeyScanTask__p9105106151517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateHotkeyScanTask__p5105864158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row51059641520"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p1310536171516">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p8105126111515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p1710518618153">Hot key analysis record ID.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row2010511619158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p151061364156">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p191061067156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p31065617158">Instance ID.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row610596121512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p10106176191510">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p1210606141516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p121061769152">Analysis task status. Value range:</p>
<ul id="CreateHotkeyScanTask__ul06615281148"><li id="CreateHotkeyScanTask__li12661202831415"><strong id="CreateHotkeyScanTask__b916914312216">waiting</strong></li><li id="CreateHotkeyScanTask__li366112851416"><strong id="CreateHotkeyScanTask__b31701831132116">running</strong></li><li id="CreateHotkeyScanTask__li1966218281148"><strong id="CreateHotkeyScanTask__b1170731132118">success</strong></li><li id="CreateHotkeyScanTask__li26621928151411"><strong id="CreateHotkeyScanTask__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row141054611518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p61065610156">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p41061671513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p15106265152">Analysis method. Value range:</p>
<ul id="CreateHotkeyScanTask__ul33881240111911"><li id="CreateHotkeyScanTask__li83881540121913"><strong id="CreateHotkeyScanTask__b4602204710204">manual</strong></li><li id="CreateHotkeyScanTask__li19388144031918"><strong id="CreateHotkeyScanTask__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row1110516691518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p191063612150">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p310606151516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p16106146171510">Time when an analysis task is created. The format is <strong id="CreateHotkeyScanTask__b810611614159">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row610586131519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p1410686191519">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p161061567156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p20106146121510">Time when an analysis task started. The format is <strong id="CreateHotkeyScanTask__b9106367159">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateHotkeyScanTask__b121067621514">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row14105136101510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p31061262155">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p1510686161514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p51061061152">Time when an analysis task ended. The format is <strong id="CreateHotkeyScanTask__b5106166101516">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateHotkeyScanTask__b171064611514">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row8105176181512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p510656151512">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p13107163151">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateHotkeyScanTask__p131071616151">Number of hot keys.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row111051361159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateHotkeyScanTask__p2107166121511">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateHotkeyScanTask__p1510766191517">Array of <a href="#CreateHotkeyScanTask__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="CreateHotkeyScanTask__p31074681516">Hot key record. (The value is <strong id="CreateHotkeyScanTask__b161071969158">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateHotkeyScanTask__response_HotkeysBody"></a><a name="response_HotkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__response_HotkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>HotkeysBody</caption><thead align="left"><tr id="CreateHotkeyScanTask__row101078621515"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateHotkeyScanTask__p210717651511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateHotkeyScanTask__p81071567151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateHotkeyScanTask__p110714691518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row81078619159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p61071062154">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p181071966155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p1010715671511">Key name.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row14107136181516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p1310816651513">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p151083671516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p17108136121518">Key type. Value range:</p>
<ul id="CreateHotkeyScanTask__ul196681728141413"><li id="CreateHotkeyScanTask__li176681328111416"><strong id="CreateHotkeyScanTask__b0636218204">string</strong></li><li id="CreateHotkeyScanTask__li166842814146"><strong id="CreateHotkeyScanTask__b29759813202">list</strong></li><li id="CreateHotkeyScanTask__li18668192891410"><strong id="CreateHotkeyScanTask__b1872311102011">set</strong></li><li id="CreateHotkeyScanTask__li1666892813141"><strong id="CreateHotkeyScanTask__b113281314172016">zset</strong></li><li id="CreateHotkeyScanTask__li76681028121412"><strong id="CreateHotkeyScanTask__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row1810712610157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p111087611157">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p210818611512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p2010817610159">Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="CreateHotkeyScanTask__b21084601515">ip:port</strong>.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row81074612159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p171085611511">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p151086615159">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p1210846191510">Database where a hot key is located.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row41071463157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p11108666155">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p910817617153">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p7108265157">Size of the key value.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row01071562155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p510813661514">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p41081166151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p91085631518">Key unit. <strong id="CreateHotkeyScanTask__b1510812671512">count</strong>: number of keys; <strong id="CreateHotkeyScanTask__b1210816613152">byte</strong>: key size.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row131071362158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateHotkeyScanTask__p610810611511">freq</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateHotkeyScanTask__p17108165152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateHotkeyScanTask__p1010856191513">Reflects the access frequency of a key within a specific period of time.</p>
<p id="CreateHotkeyScanTask__p71082062152">The value is the logarithmic access frequency counter. The maximum value is <strong id="CreateHotkeyScanTask__b610866191511">255</strong>, which indicates 1 million access requests. After the frequency reaches <strong id="CreateHotkeyScanTask__b1810866191513">255</strong>, the value will no longer increase even if access requests continue to increase. The value will decrease by <strong id="CreateHotkeyScanTask__b71081163154">1</strong> for every minute during which the key is not accessed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateHotkeyScanTask__p0109106131517"><strong id="CreateHotkeyScanTask__b910911614159">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row191098671514"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="CreateHotkeyScanTask__p15109166161510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="CreateHotkeyScanTask__p181091619159">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="CreateHotkeyScanTask__p810916101514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row810920618155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateHotkeyScanTask__p141093619155">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateHotkeyScanTask__p81090621518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateHotkeyScanTask__p51090618155">Error message.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row41095691514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateHotkeyScanTask__p710919617157">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateHotkeyScanTask__p210911631517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateHotkeyScanTask__p41094641514">Error code.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row810918612154"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateHotkeyScanTask__p410910612153">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateHotkeyScanTask__p151099619152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateHotkeyScanTask__p101090651515">Extended error information. This parameter is not used currently and is set to <strong id="CreateHotkeyScanTask__b1310912619153">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateHotkeyScanTask__p61092619157"><strong id="CreateHotkeyScanTask__b171091968153">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__table910919610156" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row181101162151"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="CreateHotkeyScanTask__p181101269154">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="CreateHotkeyScanTask__p511011651516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="CreateHotkeyScanTask__p6110863153">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row111105631512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateHotkeyScanTask__p611046151516">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateHotkeyScanTask__p4110562156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateHotkeyScanTask__p14110963158">Error message.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row51103610159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateHotkeyScanTask__p1811016618159">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateHotkeyScanTask__p911076111512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateHotkeyScanTask__p141102631516">Error code.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row011010621510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateHotkeyScanTask__p1311018651520">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateHotkeyScanTask__p1011011611511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateHotkeyScanTask__p1011018681517">Extended error information. This parameter is not used currently and is set to <strong id="CreateHotkeyScanTask__b15110186141519">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateHotkeyScanTask__p51101163158"><strong id="CreateHotkeyScanTask__b121104631517">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__table811018612156" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row11111964154"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="CreateHotkeyScanTask__p161110681513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="CreateHotkeyScanTask__p1711126121518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="CreateHotkeyScanTask__p31118671516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row21111864153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateHotkeyScanTask__p191111465155">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateHotkeyScanTask__p171111267159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateHotkeyScanTask__p1611116181514">Error message.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row1411119691514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateHotkeyScanTask__p81118618154">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateHotkeyScanTask__p101111968158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateHotkeyScanTask__p91111367157">Error code.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row71111681510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateHotkeyScanTask__p811113611519">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateHotkeyScanTask__p1911110671510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateHotkeyScanTask__p811111613156">Extended error information. This parameter is not used currently and is set to <strong id="CreateHotkeyScanTask__b1011119611154">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateHotkeyScanTask__p1611115619157"><strong id="CreateHotkeyScanTask__b19111167156">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__table21119618159" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row01111867154"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="CreateHotkeyScanTask__p1112261156">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="CreateHotkeyScanTask__p51127618157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="CreateHotkeyScanTask__p2112146171517">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row61121611510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateHotkeyScanTask__p11129601515">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateHotkeyScanTask__p9112206101514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateHotkeyScanTask__p1811213681511">Error message.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row181125611515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateHotkeyScanTask__p15112765155">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateHotkeyScanTask__p191120619151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateHotkeyScanTask__p411213671514">Error code.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row9112560150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateHotkeyScanTask__p16112186131518">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateHotkeyScanTask__p1211236101516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateHotkeyScanTask__p81120661519">Extended error information. This parameter is not used currently and is set to <strong id="CreateHotkeyScanTask__b121121966158">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateHotkeyScanTask__p11112126191518"><strong id="CreateHotkeyScanTask__b011216681518">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__table8112862154" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateHotkeyScanTask__row4112768151"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="CreateHotkeyScanTask__p111131165154">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="CreateHotkeyScanTask__p1311316611155">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="CreateHotkeyScanTask__p811319616153">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row511216121510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateHotkeyScanTask__p141131568152">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateHotkeyScanTask__p1711312651512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateHotkeyScanTask__p81131862150">Error message.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row411246131516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateHotkeyScanTask__p191133615153">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateHotkeyScanTask__p171133621513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateHotkeyScanTask__p611320651515">Error code.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row811276151513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateHotkeyScanTask__p9113969158">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateHotkeyScanTask__p191132612152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateHotkeyScanTask__p4113146181510">Extended error information. This parameter is not used currently and is set to <strong id="CreateHotkeyScanTask__b8113467153">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateHotkeyScanTask__section171134611513"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="CreateHotkeyScanTask__screen181134612158">POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task</pre>
</div>
<div class="section" id="CreateHotkeyScanTask__section111313691516"><h4 class="sectiontitle">Example Responses</h4><p id="CreateHotkeyScanTask__p01136691517"><strong id="CreateHotkeyScanTask__b1711376141511">Status code: 200</strong></p>
<p id="CreateHotkeyScanTask__p1311346121511">Hot key analysis task created successfully.</p>
<pre class="screen" id="CreateHotkeyScanTask__screen111413618157">{
"id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a",
"instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
"status" : "waiting",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z",
"num" : 0
}</pre>
<p id="CreateHotkeyScanTask__p61140611514"><strong id="CreateHotkeyScanTask__b81149613151">Status code: 400</strong></p>
<p id="CreateHotkeyScanTask__p1611456121513">Invalid request.</p>
<pre class="screen" id="CreateHotkeyScanTask__screen71142631511">{
"error_code" : "DCS.4922",
"error_msg" : "Does not support hotkey analyze."
}</pre>
</div>
<div class="section" id="CreateHotkeyScanTask__section191141364151"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateHotkeyScanTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateHotkeyScanTask__row181148612157"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateHotkeyScanTask__p1911415616152">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateHotkeyScanTask__p51151664154">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateHotkeyScanTask__row3114964154"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p311516617156">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p0115196111519">Hot key analysis task created successfully.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row8114464157"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p21151681517">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p161151462159">Invalid request.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row18114369153"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p1311511615154">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p1611576121514">Invalid authentication information.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row17114106141512"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p41157615152">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p21153611514">The request is rejected.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row1711476111510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p161151164152">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p20115269151">The requested resource is not found.</p>
</td>
</tr>
<tr id="CreateHotkeyScanTask__row181141862151"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateHotkeyScanTask__p71157661517">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateHotkeyScanTask__p611518671519">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateHotkeyScanTask__section18115156151512"><h4 class="sectiontitle">Error Codes</h4><p id="CreateHotkeyScanTask__p811517611518">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