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

442 lines
34 KiB
HTML
Raw Blame History

<a name="ShowHotkeyTaskDetails"></a><a name="ShowHotkeyTaskDetails"></a>
<h1 class="topictitle1">Querying Hot Key Analysis Details</h1>
<div id="body1708331107508"><div class="section" id="ShowHotkeyTaskDetails__section13186186191517"><h4 class="sectiontitle">Function</h4><p id="ShowHotkeyTaskDetails__p1118716121515">This API is used to query the hot key analysis details.</p>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section618711621516"><h4 class="sectiontitle">URI</h4><p id="ShowHotkeyTaskDetails__p191873615153">GET /v2/{project_id}/instances/{instance_id}/hotkey-task/{hotkey_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__table81870615151" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row1918714615156"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowHotkeyTaskDetails__p1018711619152">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowHotkeyTaskDetails__p918716131520">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowHotkeyTaskDetails__p1218812615151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowHotkeyTaskDetails__p101880681516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row181874611152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowHotkeyTaskDetails__p518846131519">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowHotkeyTaskDetails__p618817681513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowHotkeyTaskDetails__p1188761159">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowHotkeyTaskDetails__p1418846191516">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1718711611514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowHotkeyTaskDetails__p1418819617153">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowHotkeyTaskDetails__p131881613156">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowHotkeyTaskDetails__p61881760157">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowHotkeyTaskDetails__p31889601510">Instance ID.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1018746171514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowHotkeyTaskDetails__p0188762152">hotkey_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowHotkeyTaskDetails__p818836201513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowHotkeyTaskDetails__p21881367154">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowHotkeyTaskDetails__p4188186171519">ID of the hot key analysis task.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section1418819618154"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowHotkeyTaskDetails__p1188106191510">None</p>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section17189136171513"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowHotkeyTaskDetails__p9189206131514"><strong id="ShowHotkeyTaskDetails__b6189186101519">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__response_HotkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row2189166181517"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowHotkeyTaskDetails__p61891765151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowHotkeyTaskDetails__p191898671519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowHotkeyTaskDetails__p6189666156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row31896618154"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p20190560158">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p121901169158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p141904631515">Hot key analysis record ID.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row71892615155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p0190567151">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p1819016614153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p18190067153">Instance ID.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row61892617152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p121904612153">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p419017611511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p91908601516">Analysis task status. Value range:</p>
<ul id="ShowHotkeyTaskDetails__ul01233515421"><li id="ShowHotkeyTaskDetails__li91238513427"><strong id="ShowHotkeyTaskDetails__b2012345116428">waiting</strong></li><li id="ShowHotkeyTaskDetails__li13123951134219"><strong id="ShowHotkeyTaskDetails__b111235518428">running</strong></li><li id="ShowHotkeyTaskDetails__li17123165144211"><strong id="ShowHotkeyTaskDetails__b71231751174210">success</strong></li><li id="ShowHotkeyTaskDetails__li1112385110426"><strong id="ShowHotkeyTaskDetails__b1312315114426">failed</strong></li></ul>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row118976161518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p019018613152">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p519013611513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p019012616151">Analysis method. Value range:</p>
<ul id="ShowHotkeyTaskDetails__ul33881240111911"><li id="ShowHotkeyTaskDetails__li83881540121913"><strong id="ShowHotkeyTaskDetails__b4602204710204">manual</strong></li><li id="ShowHotkeyTaskDetails__li19388144031918"><strong id="ShowHotkeyTaskDetails__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row151898681510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p14190267159">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p119086151514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p171905612159">Time when an analysis task is created. The format is <strong id="ShowHotkeyTaskDetails__b41901560152">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row4189136171517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p719011613159">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p319096111514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p1619146141512">Time when an analysis task started. The format is <strong id="ShowHotkeyTaskDetails__b131919691512">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="ShowHotkeyTaskDetails__b31911466151">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row61894621517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p141914691511">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p16191106121511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p101910611154">Time when an analysis task ended. The format is <strong id="ShowHotkeyTaskDetails__b13191661157">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="ShowHotkeyTaskDetails__b1619166111515">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row14189176101518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p81918610150">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p201912060152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p151916619155">Number of hot keys.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1618918620153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p131915612150">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p18191466155">Array of <a href="#ShowHotkeyTaskDetails__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="ShowHotkeyTaskDetails__p161911651516">Hot key record. (The value is <strong id="ShowHotkeyTaskDetails__b151919611515">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowHotkeyTaskDetails__response_HotkeysBody"></a><a name="response_HotkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__response_HotkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>HotkeysBody</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row1191365152"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowHotkeyTaskDetails__p41928614158">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowHotkeyTaskDetails__p1619214618152">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowHotkeyTaskDetails__p81927641519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row151911369151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p12192167156">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p121926661513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p111921619153">Key name.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row8191156161511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p619256201517">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p101921961159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p161926612158">Key type. Value range:</p>
<ul id="ShowHotkeyTaskDetails__ul196681728141413"><li id="ShowHotkeyTaskDetails__li176681328111416"><strong id="ShowHotkeyTaskDetails__b0636218204">string</strong></li><li id="ShowHotkeyTaskDetails__li166842814146"><strong id="ShowHotkeyTaskDetails__b29759813202">list</strong></li><li id="ShowHotkeyTaskDetails__li18668192891410"><strong id="ShowHotkeyTaskDetails__b1872311102011">set</strong></li><li id="ShowHotkeyTaskDetails__li1666892813141"><strong id="ShowHotkeyTaskDetails__b113281314172016">zset</strong></li><li id="ShowHotkeyTaskDetails__li76681028121412"><strong id="ShowHotkeyTaskDetails__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row18191861153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p71929615153">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p01921613156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p11192116191514">Shard where the hot key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="ShowHotkeyTaskDetails__b1919211631511">ip:port</strong>.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row71913661516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p19192126181519">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p71922614158">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p51931062155">Database where a hot key is located.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row41919618152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p31934620150">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p819356141518">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p17193176141510">Size of the key value.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1819118671518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p1019376101510">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p0193869158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p719326141515">Key unit. <strong id="ShowHotkeyTaskDetails__b12193561155">count</strong>: number of keys; <strong id="ShowHotkeyTaskDetails__b1819317601510">byte</strong>: key size.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row151913616156"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p31937617151">freq</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p81937615158">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p1019315641511">Reflects the access frequency of a key within a specific period of time.</p>
<p id="ShowHotkeyTaskDetails__p51934613155">The value is the logarithmic access frequency counter. The maximum value is <strong id="ShowHotkeyTaskDetails__b219316671512">255</strong>, which indicates 1 million access requests. After the frequency reaches <strong id="ShowHotkeyTaskDetails__b17193763151">255</strong>, the value will no longer increase even if access requests continue to increase. The value will decrease by <strong id="ShowHotkeyTaskDetails__b16193763152">1</strong> for every minute during which the key is not accessed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowHotkeyTaskDetails__p18193156101518"><strong id="ShowHotkeyTaskDetails__b5193463158">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row1719416613151"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowHotkeyTaskDetails__p919412620152">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowHotkeyTaskDetails__p1919426101512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowHotkeyTaskDetails__p31941615159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row919456201511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p161941668154">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p419486141518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p1619415661511">Error message.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row619486111515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p1219419618158">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p13194186151511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p131949620155">Error code.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row171941261158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p419417671516">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p1619412601512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p219410620159">Extended error information. This parameter is not used currently and is set to <strong id="ShowHotkeyTaskDetails__b10195116111518">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowHotkeyTaskDetails__p219510612151"><strong id="ShowHotkeyTaskDetails__b719519631514">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__table11950621511" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row21957618156"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowHotkeyTaskDetails__p14195106191514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowHotkeyTaskDetails__p7195176201511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowHotkeyTaskDetails__p7195146161512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row1219514661511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p6195106161514">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p191951563156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p91951364158">Error message.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row14195968157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p1919517614158">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p2019516619158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p1119510691518">Error code.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1419511661519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p1019511618159">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p91953613152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p51964618157">Extended error information. This parameter is not used currently and is set to <strong id="ShowHotkeyTaskDetails__b101969621517">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowHotkeyTaskDetails__p121961362153"><strong id="ShowHotkeyTaskDetails__b519611612153">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__table13196869157" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row1019646171518"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ShowHotkeyTaskDetails__p219636141519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ShowHotkeyTaskDetails__p71961769158">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ShowHotkeyTaskDetails__p61962691519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row19196262156"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p181961261157">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p121968631515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p1019686171519">Error message.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row5196116121519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p219619651519">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p01961565158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p619619671520">Error code.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1196560151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p419616191516">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p15197146111514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p151971068158">Extended error information. This parameter is not used currently and is set to <strong id="ShowHotkeyTaskDetails__b12197126171510">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowHotkeyTaskDetails__p12197361159"><strong id="ShowHotkeyTaskDetails__b51978613154">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__table1919713611154" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row519720614153"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ShowHotkeyTaskDetails__p7197366157">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ShowHotkeyTaskDetails__p151971363153">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ShowHotkeyTaskDetails__p11197263154">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row81979612150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p6197176141513">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p1519714611510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p41976615157">Error message.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row119716671513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p21971961157">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p11197176111511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p21980631511">Error code.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1197869158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p71981165159">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p181981666157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p019815620156">Extended error information. This parameter is not used currently and is set to <strong id="ShowHotkeyTaskDetails__b7198176111510">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowHotkeyTaskDetails__p11986614153"><strong id="ShowHotkeyTaskDetails__b191981162156">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__table11987601510" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowHotkeyTaskDetails__row15198868150"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ShowHotkeyTaskDetails__p1119815618157">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ShowHotkeyTaskDetails__p1519816611513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ShowHotkeyTaskDetails__p21985641511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row5198176151512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p719815621513">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p171981762158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p41998691514">Error message.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row01986611512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p819911617152">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p8199126131519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p131998616155">Error code.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row20198186171517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ShowHotkeyTaskDetails__p91991160158">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ShowHotkeyTaskDetails__p5199136181517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ShowHotkeyTaskDetails__p219912613156">Extended error information. This parameter is not used currently and is set to <strong id="ShowHotkeyTaskDetails__b719918681519">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section151996616153"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowHotkeyTaskDetails__screen320115615156">GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-task/0ccb25d5-27cf-4188-b5ea-987730a85371</pre>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section14201106171513"><h4 class="sectiontitle">Example Responses</h4><p id="ShowHotkeyTaskDetails__p12017631513"><strong id="ShowHotkeyTaskDetails__b620118613159">Status code: 200</strong></p>
<p id="ShowHotkeyTaskDetails__p7201116141517">Hot key analysis details queried successfully.</p>
<pre class="screen" id="ShowHotkeyTaskDetails__screen13201126131514">{
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"status" : "success",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z",
"started_at" : "2020-06-15T02:21:23.534Z",
"finished_at" : "2020-06-15T02:21:25.588Z",
"keys" : [ {
"name" : "dcs-hotkey-test",
"type" : "string",
"shard" : "192.168.1.134:6379",
"db" : 0,
"size" : 3000,
"unit" : "byte",
"freq" : 4
} ]
}</pre>
<p id="ShowHotkeyTaskDetails__p1220236151514"><strong id="ShowHotkeyTaskDetails__b112021861152">Status code: 400</strong></p>
<p id="ShowHotkeyTaskDetails__p1120256151511">Invalid request.</p>
<pre class="screen" id="ShowHotkeyTaskDetails__screen82023691514">{
"error_code" : "DCS.4922",
"error_msg" : "Does not support hotkey analyze."
}</pre>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section320210619154"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowHotkeyTaskDetails__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowHotkeyTaskDetails__row82036631514"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowHotkeyTaskDetails__p4203161159">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowHotkeyTaskDetails__p52036611516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowHotkeyTaskDetails__row162034691518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p112031466157">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p4203136181518">Hot key analysis details queried successfully.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row020312611518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p820316621518">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p1539846141517">Invalid request.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row4203968158"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p173999601518">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p133992064154">Invalid authentication information.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row14203567152"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p1939919613152">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p33991864151">The request is rejected.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row62038671518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p1539912618158">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p1739919601511">The requested resource is not found.</p>
</td>
</tr>
<tr id="ShowHotkeyTaskDetails__row1220318610154"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowHotkeyTaskDetails__p9399363153">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowHotkeyTaskDetails__p133991661511">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowHotkeyTaskDetails__section11399126201517"><h4 class="sectiontitle">Error Codes</h4><p id="ShowHotkeyTaskDetails__p10399146121513">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