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

421 lines
31 KiB
HTML
Raw Blame History

<a name="ListHotKeyScanTasks"></a><a name="ListHotKeyScanTasks"></a>
<h1 class="topictitle1">Listing Hot Key Analysis Tasks</h1>
<div id="body1708331107508"><div class="section" id="ListHotKeyScanTasks__section171457641516"><h4 class="sectiontitle">Function</h4><p id="ListHotKeyScanTasks__p014519619156">This API is used to query the list of hot key analysis tasks.</p>
</div>
<div class="section" id="ListHotKeyScanTasks__section3146196191513"><h4 class="sectiontitle">URI</h4><p id="ListHotKeyScanTasks__p1414606191512">GET /v2/{project_id}/instances/{instance_id}/hotkey-tasks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table111461615152" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row1814614641519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListHotKeyScanTasks__p1814612610156">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListHotKeyScanTasks__p16146563158">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListHotKeyScanTasks__p121466614157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListHotKeyScanTasks__p0146146171515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row1614617612151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListHotKeyScanTasks__p614618661516">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListHotKeyScanTasks__p314716611157">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListHotKeyScanTasks__p0147116101513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListHotKeyScanTasks__p1514710612156">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row4146156191515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListHotKeyScanTasks__p111470651511">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListHotKeyScanTasks__p2014720611513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListHotKeyScanTasks__p111479612150">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListHotKeyScanTasks__p161472611155">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table114720691512" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row131471862152"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListHotKeyScanTasks__p10147186101517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListHotKeyScanTasks__p614811681514">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListHotKeyScanTasks__p111481561155">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListHotKeyScanTasks__p7148264159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row101471464156"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListHotKeyScanTasks__p1414816616152">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListHotKeyScanTasks__p141489620158">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListHotKeyScanTasks__p1614896171518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListHotKeyScanTasks__p201489615154">Offset, which is the position where the query starts. The value must be greater than or equal to 0.</p>
<p id="ListHotKeyScanTasks__p627732153516">Default value: 0</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1147466150"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListHotKeyScanTasks__p61488610152">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListHotKeyScanTasks__p81486681512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListHotKeyScanTasks__p1148166161512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListHotKeyScanTasks__p814810621510">Number of items displayed on each page.</p>
<p id="ListHotKeyScanTasks__p109293482329">Default value: 10</p>
<p id="ListHotKeyScanTasks__p15929104818327">Value range: 1 to 1000</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row18147968150"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListHotKeyScanTasks__p161481691512">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListHotKeyScanTasks__p121481266156">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListHotKeyScanTasks__p3148166191519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListHotKeyScanTasks__p1814810619154">Analysis task status. Value range:</p>
<ul id="ListHotKeyScanTasks__ul196681728141413"><li id="ListHotKeyScanTasks__li12661202831415"><strong id="ListHotKeyScanTasks__b916914312216">waiting</strong></li><li id="ListHotKeyScanTasks__li366112851416"><strong id="ListHotKeyScanTasks__b31701831132116">running</strong></li><li id="ListHotKeyScanTasks__li1966218281148"><strong id="ListHotKeyScanTasks__b1170731132118">success</strong></li><li id="ListHotKeyScanTasks__li26621928151411"><strong id="ListHotKeyScanTasks__b8171103132110">failed</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListHotKeyScanTasks__section7148106201516"><h4 class="sectiontitle">Request Parameters</h4><p id="ListHotKeyScanTasks__p514818601512">None</p>
</div>
<div class="section" id="ListHotKeyScanTasks__section131484616152"><h4 class="sectiontitle">Response Parameters</h4><p id="ListHotKeyScanTasks__p71493641512"><strong id="ListHotKeyScanTasks__b1314917671513">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__response_HotkeyHistoriesResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row15149156131520"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListHotKeyScanTasks__p41492068153">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListHotKeyScanTasks__p1814956171510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListHotKeyScanTasks__p1114917621514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row214915618151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListHotKeyScanTasks__p191493619152">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListHotKeyScanTasks__p6149965152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListHotKeyScanTasks__p101492063159">Instance ID.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1614946131516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListHotKeyScanTasks__p19149146121520">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListHotKeyScanTasks__p1614976111514">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListHotKeyScanTasks__p17149186111513">Number of times that hot keys are analyzed.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row91496601519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListHotKeyScanTasks__p2014913671512">records</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListHotKeyScanTasks__p1714956131511">Array of <a href="#ListHotKeyScanTasks__response_RecordsResponse">RecordsResponse</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListHotKeyScanTasks__p31507613156">List of hot key analysis record.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListHotKeyScanTasks__response_RecordsResponse"></a><a name="response_RecordsResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__response_RecordsResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>RecordsResponse</caption><thead align="left"><tr id="ListHotKeyScanTasks__row121501168150"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListHotKeyScanTasks__p17150186111517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListHotKeyScanTasks__p815019631515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListHotKeyScanTasks__p915016201510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row61509614157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p1215016612153">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p915066101517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p101501267157">Task execution record ID. (This ID corresponds to the task ID in the parameter for querying big key or hot key analysis details.)</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row14150156101518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p131503612157">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p4150146171511">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p11507612151">Analysis task status. Value range:</p>
<ul id="ListHotKeyScanTasks__ul01233515421"><li id="ListHotKeyScanTasks__li91238513427"><strong id="ListHotKeyScanTasks__b2012345116428">waiting</strong></li><li id="ListHotKeyScanTasks__li13123951134219"><strong id="ListHotKeyScanTasks__b111235518428">running</strong></li><li id="ListHotKeyScanTasks__li17123165144211"><strong id="ListHotKeyScanTasks__b71231751174210">success</strong></li><li id="ListHotKeyScanTasks__li1112385110426"><strong id="ListHotKeyScanTasks__b1312315114426">failed</strong></li></ul>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row415066101515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p215015621510">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p51513620152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p61511963159">Analysis method. Value range:</p>
<ul id="ListHotKeyScanTasks__ul33881240111911"><li id="ListHotKeyScanTasks__li83881540121913"><strong id="ListHotKeyScanTasks__b4602204710204">manual</strong></li><li id="ListHotKeyScanTasks__li19388144031918"><strong id="ListHotKeyScanTasks__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1215011611153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p1015126131514">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p1715111631518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p1515112613157">Time when an analysis task is created. The format is <strong id="ListHotKeyScanTasks__b115118619151">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row101501681519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p51511671510">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p1515106161520">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p7151964159">Time when an analysis task started. The format is <strong id="ListHotKeyScanTasks__b71511669156">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1615017691510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListHotKeyScanTasks__p61510617158">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListHotKeyScanTasks__p10151562156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListHotKeyScanTasks__p515113661515">Time when an analysis task ended. The format is <strong id="ListHotKeyScanTasks__b3151367158">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListHotKeyScanTasks__p6151169156"><strong id="ListHotKeyScanTasks__b31511611511">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row121516631515"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListHotKeyScanTasks__p415156151519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListHotKeyScanTasks__p2015112614152">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListHotKeyScanTasks__p161529612158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row71510611511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListHotKeyScanTasks__p1615217611157">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListHotKeyScanTasks__p171523691519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListHotKeyScanTasks__p115220681519">Error message.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row815117610152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListHotKeyScanTasks__p215216141510">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListHotKeyScanTasks__p1515246151515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListHotKeyScanTasks__p71523614152">Error code.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1415112671512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListHotKeyScanTasks__p1915246131515">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListHotKeyScanTasks__p41527614158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListHotKeyScanTasks__p1152156191518">Extended error information. This parameter is not used currently and is set to <strong id="ListHotKeyScanTasks__b6152965158">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListHotKeyScanTasks__p131521868155"><strong id="ListHotKeyScanTasks__b115286111518">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table71521610155" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row14152461159"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListHotKeyScanTasks__p4152146161517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListHotKeyScanTasks__p1215217612157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListHotKeyScanTasks__p11153864150">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row1515220661513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListHotKeyScanTasks__p121531641515">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListHotKeyScanTasks__p815312641520">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListHotKeyScanTasks__p11539631518">Error message.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row0152126171510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListHotKeyScanTasks__p101535610157">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListHotKeyScanTasks__p61539671512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListHotKeyScanTasks__p1615314611158">Error code.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row141524617151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListHotKeyScanTasks__p515317611519">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListHotKeyScanTasks__p1015313681519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListHotKeyScanTasks__p1815314612151">Extended error information. This parameter is not used currently and is set to <strong id="ListHotKeyScanTasks__b171538641514">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListHotKeyScanTasks__p1815318601513"><strong id="ListHotKeyScanTasks__b141531641514">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table1115326191519" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row21538612154"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ListHotKeyScanTasks__p215319616154">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ListHotKeyScanTasks__p181541165151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ListHotKeyScanTasks__p111540611514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row1415336151517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListHotKeyScanTasks__p6154106131519">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListHotKeyScanTasks__p1615436131512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListHotKeyScanTasks__p1815413610157">Error message.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row01533616150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListHotKeyScanTasks__p3154562156">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListHotKeyScanTasks__p1015496151516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListHotKeyScanTasks__p01541766155">Error code.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row171531867151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListHotKeyScanTasks__p2154166101514">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListHotKeyScanTasks__p51541262155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListHotKeyScanTasks__p5154146161519">Extended error information. This parameter is not used currently and is set to <strong id="ListHotKeyScanTasks__b181541767156">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListHotKeyScanTasks__p81545612159"><strong id="ListHotKeyScanTasks__b12154136191517">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table71541868158" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row151541268159"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ListHotKeyScanTasks__p161548681514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ListHotKeyScanTasks__p16155162152">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ListHotKeyScanTasks__p1615516611157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row3154206171512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListHotKeyScanTasks__p8155106141520">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListHotKeyScanTasks__p3155146161512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListHotKeyScanTasks__p715566201519">Error message.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row15154126151518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListHotKeyScanTasks__p1415513619150">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListHotKeyScanTasks__p01553651510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListHotKeyScanTasks__p151551613155">Error code.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row4154206111519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListHotKeyScanTasks__p141551765154">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListHotKeyScanTasks__p6155106101514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListHotKeyScanTasks__p6155136201514">Extended error information. This parameter is not used currently and is set to <strong id="ListHotKeyScanTasks__b4155106131517">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListHotKeyScanTasks__p11552651514"><strong id="ListHotKeyScanTasks__b14155468151">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__table11155126161513" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListHotKeyScanTasks__row101556611158"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ListHotKeyScanTasks__p41563613153">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ListHotKeyScanTasks__p14156463159">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ListHotKeyScanTasks__p3156146171510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row11551964158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListHotKeyScanTasks__p131564631515">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListHotKeyScanTasks__p41561618156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListHotKeyScanTasks__p14156156191516">Error message.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row1715617618157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListHotKeyScanTasks__p1156364151">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListHotKeyScanTasks__p151565681510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListHotKeyScanTasks__p101567601519">Error code.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row715676181519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListHotKeyScanTasks__p815636121514">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListHotKeyScanTasks__p31561765151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListHotKeyScanTasks__p71561867157">Extended error information. This parameter is not used currently and is set to <strong id="ListHotKeyScanTasks__b15156176101514">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListHotKeyScanTasks__section121568621515"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListHotKeyScanTasks__screen415616610159">GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/hotkey-tasks</pre>
</div>
<div class="section" id="ListHotKeyScanTasks__section141571363150"><h4 class="sectiontitle">Example Responses</h4><p id="ListHotKeyScanTasks__p171570614154"><strong id="ListHotKeyScanTasks__b61578621513">Status code: 200</strong></p>
<p id="ListHotKeyScanTasks__p1115717615157">Hot key analysis tasks listed successfully.</p>
<pre class="screen" id="ListHotKeyScanTasks__screen81574681512">{
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"count" : 1,
"records" : [ {
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"scan_type" : "manual",
"status" : "success",
"created_at" : "2020-06-15T02:21:18.669Z",
"started_at" : "2020-06-15T02:21:23.534Z",
"finished_at" : "2020-06-15T02:21:25.588Z"
} ]
}</pre>
<p id="ListHotKeyScanTasks__p181571162150"><strong id="ListHotKeyScanTasks__b1715718615155">Status code: 400</strong></p>
<p id="ListHotKeyScanTasks__p1915716151513">Invalid request.</p>
<pre class="screen" id="ListHotKeyScanTasks__screen61571264154">{
"error_code" : "DCS.4922",
"error_msg" : "Does not support hotkey analyze."
}</pre>
</div>
<div class="section" id="ListHotKeyScanTasks__section10157966158"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListHotKeyScanTasks__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListHotKeyScanTasks__row17158265154"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListHotKeyScanTasks__p1215813681516">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListHotKeyScanTasks__p91584618156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListHotKeyScanTasks__row1815812618156"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p131583615154">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p1158167153">Hot key analysis tasks listed successfully.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row14158176111518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p2015856171515">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p315820611516">Invalid request.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row51582614155"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p515856201514">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p1815820681519">Invalid authentication information.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row131587612150"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p41581566153">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p11158268157">The request is rejected.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row191581365159"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p91585619159">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p121591963159">The requested resource is not found.</p>
</td>
</tr>
<tr id="ListHotKeyScanTasks__row101586610158"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListHotKeyScanTasks__p14159136201515">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListHotKeyScanTasks__p171591061155">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListHotKeyScanTasks__section61592671514"><h4 class="sectiontitle">Error Codes</h4><p id="ListHotKeyScanTasks__p1215976101519">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