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

416 lines
30 KiB
HTML
Raw Blame History

<a name="ListBigkeyScanTasks"></a><a name="ListBigkeyScanTasks"></a>
<h1 class="topictitle1">Listing Big Key Analysis Tasks</h1>
<div id="body1708331107508"><div class="section" id="ListBigkeyScanTasks__section186382511158"><h4 class="sectiontitle">Function</h4><p id="ListBigkeyScanTasks__p4638175151514">This API is used to query the list of big key analysis tasks.</p>
</div>
<div class="section" id="ListBigkeyScanTasks__section663813513150"><h4 class="sectiontitle">URI</h4><p id="ListBigkeyScanTasks__p46382519155">GET /v2/{project_id}/instances/{instance_id}/bigkey-tasks</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table1963925181517" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row18638125151519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListBigkeyScanTasks__p963918517155">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListBigkeyScanTasks__p1563913511155">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListBigkeyScanTasks__p163975121512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListBigkeyScanTasks__p363917581520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row06381255159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListBigkeyScanTasks__p1363955101515">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListBigkeyScanTasks__p106396510152">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListBigkeyScanTasks__p1863945181512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListBigkeyScanTasks__p663995181518">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row1063810581512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListBigkeyScanTasks__p1563915151517">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListBigkeyScanTasks__p1563995141511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListBigkeyScanTasks__p1063975101516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListBigkeyScanTasks__p1639353151">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table763913519158" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row1063912513151"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListBigkeyScanTasks__p17639175161511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListBigkeyScanTasks__p3640155171519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListBigkeyScanTasks__p186406511512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListBigkeyScanTasks__p364016521518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row1063914521520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBigkeyScanTasks__p206408541511">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBigkeyScanTasks__p4640175111516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBigkeyScanTasks__p156401051152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBigkeyScanTasks__p146401252155">Offset, which is the position where the query starts. The value must be greater than or equal to 0.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row1363919591519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBigkeyScanTasks__p66409513150">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBigkeyScanTasks__p1364025111511">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBigkeyScanTasks__p96406511512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBigkeyScanTasks__p26401858158">Number of items displayed on each page.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row10639185151514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBigkeyScanTasks__p126407512151">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBigkeyScanTasks__p14640125161512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBigkeyScanTasks__p1664017561510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBigkeyScanTasks__p564015521513">Analysis task status. Value range:</p>
<ul id="ListBigkeyScanTasks__ul06615281148"><li id="ListBigkeyScanTasks__li12661202831415"><strong id="ListBigkeyScanTasks__b916914312216">waiting</strong></li><li id="ListBigkeyScanTasks__li366112851416"><strong id="ListBigkeyScanTasks__b31701831132116">running</strong></li><li id="ListBigkeyScanTasks__li1966218281148"><strong id="ListBigkeyScanTasks__b1170731132118">success</strong></li><li id="ListBigkeyScanTasks__li26621928151411"><strong id="ListBigkeyScanTasks__b8171103132110">failed</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBigkeyScanTasks__section064014521515"><h4 class="sectiontitle">Request Parameters</h4><p id="ListBigkeyScanTasks__p064018513154">None</p>
</div>
<div class="section" id="ListBigkeyScanTasks__section16640156151"><h4 class="sectiontitle">Response Parameters</h4><p id="ListBigkeyScanTasks__p156408551517"><strong id="ListBigkeyScanTasks__b4640759153">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__response_BigkeyHistoriesResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row1664105171516"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListBigkeyScanTasks__p10641155161516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListBigkeyScanTasks__p126415531519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListBigkeyScanTasks__p364119551514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row1664116581513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBigkeyScanTasks__p16641135151517">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBigkeyScanTasks__p764113531515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBigkeyScanTasks__p10641145121510">Instance ID.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row1964110514152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBigkeyScanTasks__p564105121512">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBigkeyScanTasks__p96411959159">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBigkeyScanTasks__p116411155150">Number of times that big keys are analyzed.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row126415518152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBigkeyScanTasks__p3641851153">records</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBigkeyScanTasks__p1641115101519">Array of <a href="#ListBigkeyScanTasks__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="ListBigkeyScanTasks__p176410519153">List of big key analysis record.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListBigkeyScanTasks__response_RecordsResponse"></a><a name="response_RecordsResponse"></a><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__response_RecordsResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>RecordsResponse</caption><thead align="left"><tr id="ListBigkeyScanTasks__row66416511511"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListBigkeyScanTasks__p1564245111512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListBigkeyScanTasks__p176421956157">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListBigkeyScanTasks__p2642353157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row764111520153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p464220515154">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p136422519153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p146421255157">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="ListBigkeyScanTasks__row1264219541515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p364255131512">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p56421453155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p17642458152">Analysis task status.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row364255181514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p1564216519151">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p116420521519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p664212512152">Analysis method.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row146424581513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p06421558156">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p1164212501513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p1064212515158">Time when an analysis task is created. The format is <strong id="ListBigkeyScanTasks__b16642253155">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row19642251155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p9642253150">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p964345101513">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p206431658153">Time when an analysis task started. The format is <strong id="ListBigkeyScanTasks__b06431952155">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row16421254156"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBigkeyScanTasks__p11643185101519">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBigkeyScanTasks__p126438581519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBigkeyScanTasks__p20643145101515">Time when an analysis task ended. The format is <strong id="ListBigkeyScanTasks__b166433531520">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListBigkeyScanTasks__p1964314541510"><strong id="ListBigkeyScanTasks__b1064314517153">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row764320521512"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListBigkeyScanTasks__p146431859151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListBigkeyScanTasks__p1064314510153">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListBigkeyScanTasks__p4643154154">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row1564311531516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListBigkeyScanTasks__p186434571514">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListBigkeyScanTasks__p0643185101518">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListBigkeyScanTasks__p1564315101517">Error message.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row166438517152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListBigkeyScanTasks__p36431054156">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListBigkeyScanTasks__p1264385131516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListBigkeyScanTasks__p146440561516">Error code.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row0643115161512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListBigkeyScanTasks__p364455111512">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListBigkeyScanTasks__p764414521515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListBigkeyScanTasks__p764485171513">Extended error information. This parameter is not used currently and is set to <strong id="ListBigkeyScanTasks__b864445191516">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListBigkeyScanTasks__p164417561512"><strong id="ListBigkeyScanTasks__b46441958153">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table36444518157" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row66442511514"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListBigkeyScanTasks__p1764417501513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListBigkeyScanTasks__p116449521519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListBigkeyScanTasks__p1864410518155">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row464417511520"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListBigkeyScanTasks__p964410531516">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListBigkeyScanTasks__p14644125121515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListBigkeyScanTasks__p126441659153">Error message.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row19644655155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListBigkeyScanTasks__p206441571516">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListBigkeyScanTasks__p106451256155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListBigkeyScanTasks__p13645135131519">Error code.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row364417591518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListBigkeyScanTasks__p106450521512">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListBigkeyScanTasks__p1864515513154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListBigkeyScanTasks__p106457511515">Extended error information. This parameter is not used currently and is set to <strong id="ListBigkeyScanTasks__b364555191511">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListBigkeyScanTasks__p96456516152"><strong id="ListBigkeyScanTasks__b1264514521510">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table4645185181515" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row1764565101519"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ListBigkeyScanTasks__p1464615591513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ListBigkeyScanTasks__p664612571520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ListBigkeyScanTasks__p464616511159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row564514561515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListBigkeyScanTasks__p76463520153">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListBigkeyScanTasks__p176462051151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListBigkeyScanTasks__p764614531517">Error message.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row1645850157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListBigkeyScanTasks__p66465541517">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListBigkeyScanTasks__p36465511157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListBigkeyScanTasks__p364695121513">Error code.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row36455591518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListBigkeyScanTasks__p46466571520">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListBigkeyScanTasks__p1464605101512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListBigkeyScanTasks__p19646115141520">Extended error information. This parameter is not used currently and is set to <strong id="ListBigkeyScanTasks__b1764611518155">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListBigkeyScanTasks__p66463515156"><strong id="ListBigkeyScanTasks__b26461659156">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table1564619511152" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row36461654159"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="ListBigkeyScanTasks__p7647185131510">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="ListBigkeyScanTasks__p1764719591511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="ListBigkeyScanTasks__p176471250159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row1964614512152"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListBigkeyScanTasks__p13647145181518">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListBigkeyScanTasks__p864712513153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListBigkeyScanTasks__p4647135101511">Error message.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row166461550153"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListBigkeyScanTasks__p16647105101512">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListBigkeyScanTasks__p76475514158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListBigkeyScanTasks__p8647153156">Error code.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row15646145151512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="ListBigkeyScanTasks__p1664713521518">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="ListBigkeyScanTasks__p36471856154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="ListBigkeyScanTasks__p46471155153">Extended error information. This parameter is not used currently and is set to <strong id="ListBigkeyScanTasks__b76478514159">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListBigkeyScanTasks__p5647185131516"><strong id="ListBigkeyScanTasks__b196479513155">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__table1364715551517" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="ListBigkeyScanTasks__row11647756153"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="ListBigkeyScanTasks__p146471355152">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="ListBigkeyScanTasks__p14647145141512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="ListBigkeyScanTasks__p364795181510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row1364795121515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListBigkeyScanTasks__p264713515153">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListBigkeyScanTasks__p964813520159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListBigkeyScanTasks__p46484541517">Error message.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row146476571515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListBigkeyScanTasks__p264819501514">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListBigkeyScanTasks__p3648195111512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListBigkeyScanTasks__p15648658158">Error code.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row86479561515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="ListBigkeyScanTasks__p136486551512">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="ListBigkeyScanTasks__p96488516159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="ListBigkeyScanTasks__p464811517154">Extended error information. This parameter is not used currently and is set to <strong id="ListBigkeyScanTasks__b664817521512">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBigkeyScanTasks__section1764815561513"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListBigkeyScanTasks__screen3648175171519">GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-tasks</pre>
</div>
<div class="section" id="ListBigkeyScanTasks__section8648185171514"><h4 class="sectiontitle">Example Responses</h4><p id="ListBigkeyScanTasks__p8648125111510"><strong id="ListBigkeyScanTasks__b5648115151510">Status code: 200</strong></p>
<p id="ListBigkeyScanTasks__p66487518156">Big key analysis records queried successfully.</p>
<pre class="screen" id="ListBigkeyScanTasks__screen364865101510">{
"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="ListBigkeyScanTasks__p96496581516"><strong id="ListBigkeyScanTasks__b1564917581514">Status code: 400</strong></p>
<p id="ListBigkeyScanTasks__p1649175141513">Invalid request.</p>
<pre class="screen" id="ListBigkeyScanTasks__screen4649454152">{
"error_code" : "DCS.4919",
"error_msg" : "Does not support bigkey analyze."
}</pre>
</div>
<div class="section" id="ListBigkeyScanTasks__section18649165171514"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBigkeyScanTasks__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListBigkeyScanTasks__row164917571510"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListBigkeyScanTasks__p186494561518">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListBigkeyScanTasks__p064945121511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBigkeyScanTasks__row264915518155"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p96491055155">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p765055151518">Big key analysis records queried successfully.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row264945101517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p1065015521516">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p9650115111517">Invalid request.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row1649952153"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p7650165131518">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p46509515156">Invalid authentication information.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row264905161510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p36501515158">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p10650951156">The request is rejected.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row5649115151517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p126505541514">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p1365014518152">The requested resource is not found.</p>
</td>
</tr>
<tr id="ListBigkeyScanTasks__row9649357153"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBigkeyScanTasks__p465014541510">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBigkeyScanTasks__p76501513159">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBigkeyScanTasks__section36501450156"><h4 class="sectiontitle">Error Codes</h4><p id="ListBigkeyScanTasks__p8651105101517">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