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

415 lines
32 KiB
HTML
Raw Blame History

<a name="CreateBigkeyScanTask"></a><a name="CreateBigkeyScanTask"></a>
<h1 class="topictitle1">Creating a Big Key Analysis Task</h1>
<div id="body1708331107508"><div class="section" id="CreateBigkeyScanTask__section13249126131517"><h4 class="sectiontitle">Function</h4><p id="CreateBigkeyScanTask__p112494611515">This API is used to create a big key analysis task for a DCS Redis instance.</p>
</div>
<div class="section" id="CreateBigkeyScanTask__section112501368153"><h4 class="sectiontitle">URI</h4><p id="CreateBigkeyScanTask__p12507651510">POST /v2/{project_id}/instances/{instance_id}/bigkey-task</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__table1025066101515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row9250116201512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateBigkeyScanTask__p125016161519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateBigkeyScanTask__p62501669156">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateBigkeyScanTask__p1225066171512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateBigkeyScanTask__p2250064150">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row72506610153"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateBigkeyScanTask__p16250146151517">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateBigkeyScanTask__p172509614156">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateBigkeyScanTask__p62511869154">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateBigkeyScanTask__p182510612159">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row132501164159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateBigkeyScanTask__p625166121510">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateBigkeyScanTask__p1025106131510">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateBigkeyScanTask__p7251166159">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateBigkeyScanTask__p7251186191514">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateBigkeyScanTask__section13251206171513"><h4 class="sectiontitle">Request Parameters</h4><p id="CreateBigkeyScanTask__p72511669152">None</p>
</div>
<div class="section" id="CreateBigkeyScanTask__section82511671517"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateBigkeyScanTask__p1725119691516"><strong id="CreateBigkeyScanTask__b12516616158">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__response_BigkeyHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row1825118615153"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateBigkeyScanTask__p725219641516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateBigkeyScanTask__p82522620156">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateBigkeyScanTask__p5252176101520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row125111621517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p132524691519">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p5252462156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p142521966156">Big key analysis record ID.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row12512615150"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p525218621511">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p72521364152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p18252269154">Instance ID.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row0251196151513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p82521469154">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p19252562151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p13252365153">Analysis task status. Value range:</p>
<ul id="CreateBigkeyScanTask__ul06615281148"><li id="CreateBigkeyScanTask__li12661202831415"><strong id="CreateBigkeyScanTask__b916914312216">waiting</strong></li><li id="CreateBigkeyScanTask__li366112851416"><strong id="CreateBigkeyScanTask__b31701831132116">running</strong></li><li id="CreateBigkeyScanTask__li1966218281148"><strong id="CreateBigkeyScanTask__b1170731132118">success</strong></li><li id="CreateBigkeyScanTask__li26621928151411"><strong id="CreateBigkeyScanTask__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row92511063155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p1125219612152">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p192521067155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p152521962159">Analysis method. Value range:</p>
<ul id="CreateBigkeyScanTask__ul33881240111911"><li id="CreateBigkeyScanTask__li83881540121913"><strong id="CreateBigkeyScanTask__b4602204710204">manual</strong></li><li id="CreateBigkeyScanTask__li19388144031918"><strong id="CreateBigkeyScanTask__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row1625116651513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p4252206171519">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p0253161158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p525356201519">Time when an analysis task is created. The format is <strong id="CreateBigkeyScanTask__b82530618151">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row18251156131512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p5253136151511">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p11253562154">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p4253196121511">Time when an analysis task started. The format is <strong id="CreateBigkeyScanTask__b132538641518">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateBigkeyScanTask__b20253469156">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row112516681514"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p82538615157">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p162537611514">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p12253176161513">Time when an analysis task ended. The format is <strong id="CreateBigkeyScanTask__b525306151518">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateBigkeyScanTask__b12253361156">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row122511641511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p162535612154">num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p122531868154">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p11253166141513">Number of big keys.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row1625111621511"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateBigkeyScanTask__p132531660157">keys</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateBigkeyScanTask__p2025313641512">Array of <a href="#CreateBigkeyScanTask__response_BigkeysBody">BigkeysBody</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateBigkeyScanTask__p1525356131510">Big key record. (The value is <strong id="CreateBigkeyScanTask__b22535619155">null</strong> and is not returned when the analysis task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateBigkeyScanTask__response_BigkeysBody"></a><a name="response_BigkeysBody"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__response_BigkeysBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>BigkeysBody</caption><thead align="left"><tr id="CreateBigkeyScanTask__row132538617150"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="CreateBigkeyScanTask__p162547611520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="CreateBigkeyScanTask__p17254206161510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="CreateBigkeyScanTask__p172541969156">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row1625419611518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p1525417631516">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p1025419618158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p14254466158">Key name.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row19254865157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p3254463153">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p225486101516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p52544617155">Key type. Value range:</p>
<ul id="CreateBigkeyScanTask__ul196681728141413"><li id="CreateBigkeyScanTask__li176681328111416"><strong id="CreateBigkeyScanTask__b0636218204">string</strong></li><li id="CreateBigkeyScanTask__li166842814146"><strong id="CreateBigkeyScanTask__b29759813202">list</strong></li><li id="CreateBigkeyScanTask__li18668192891410"><strong id="CreateBigkeyScanTask__b1872311102011">set</strong></li><li id="CreateBigkeyScanTask__li1666892813141"><strong id="CreateBigkeyScanTask__b113281314172016">zset</strong></li><li id="CreateBigkeyScanTask__li76681028121412"><strong id="CreateBigkeyScanTask__b1452071612012">hash</strong></li></ul>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row18254766154"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p1025486141514">shard</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p4254160152">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p162542069156">Shard where the big key is located. This parameter is supported only when the instance type is cluster. The format is <strong id="CreateBigkeyScanTask__b20254065150">ip:port</strong>.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row7254261159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p825476181519">db</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p142549616153">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p925510615152">Database where a big key is located.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row13254363158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p2025514618156">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p152553613150">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p15255146191519">Size of the key value.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row72545641512"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="CreateBigkeyScanTask__p125586121510">unit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="CreateBigkeyScanTask__p172552614155">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="CreateBigkeyScanTask__p10255068158">Key unit. <strong id="CreateBigkeyScanTask__b202551617155">count</strong>: number of keys; <strong id="CreateBigkeyScanTask__b1325511613151">byte</strong>: key size.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateBigkeyScanTask__p325515619153"><strong id="CreateBigkeyScanTask__b142556613152">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row72551691516"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="CreateBigkeyScanTask__p0256126171520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="CreateBigkeyScanTask__p1425666121513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="CreateBigkeyScanTask__p225610691512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row1025511610158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateBigkeyScanTask__p192569610157">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateBigkeyScanTask__p625612618159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateBigkeyScanTask__p42562614156">Error message.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row22556614151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateBigkeyScanTask__p525676171514">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateBigkeyScanTask__p182568613157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateBigkeyScanTask__p12256066159">Error code.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row2025536171515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="CreateBigkeyScanTask__p425676101512">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="CreateBigkeyScanTask__p225686141516">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="CreateBigkeyScanTask__p102562601519">Extended error information. This parameter is not used currently and is set to <strong id="CreateBigkeyScanTask__b1625611616158">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateBigkeyScanTask__p12564691518"><strong id="CreateBigkeyScanTask__b162578616155">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__table202576611158" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row1025796201512"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="CreateBigkeyScanTask__p725710651512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="CreateBigkeyScanTask__p02571462156">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="CreateBigkeyScanTask__p1925713611514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row525746141517"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateBigkeyScanTask__p1225711651518">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateBigkeyScanTask__p19257116201517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateBigkeyScanTask__p102576641518">Error message.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row6257146191513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateBigkeyScanTask__p525776141510">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateBigkeyScanTask__p42571860158">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateBigkeyScanTask__p10257062150">Error code.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row4257462157"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="CreateBigkeyScanTask__p925811610158">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="CreateBigkeyScanTask__p82581266151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="CreateBigkeyScanTask__p182587691517">Extended error information. This parameter is not used currently and is set to <strong id="CreateBigkeyScanTask__b172581660159">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateBigkeyScanTask__p425826171510"><strong id="CreateBigkeyScanTask__b142588617150">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__table192581661512" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row102581671511"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="CreateBigkeyScanTask__p192586641518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="CreateBigkeyScanTask__p14258166131510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="CreateBigkeyScanTask__p1425866141515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row1525816610159"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateBigkeyScanTask__p1725815681516">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateBigkeyScanTask__p1725856201517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateBigkeyScanTask__p172598612152">Error message.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row1625819641519"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateBigkeyScanTask__p202594651519">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateBigkeyScanTask__p192591963153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateBigkeyScanTask__p15259186101514">Error code.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row182586691515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="CreateBigkeyScanTask__p172591467152">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="CreateBigkeyScanTask__p32598681512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="CreateBigkeyScanTask__p325916611156">Extended error information. This parameter is not used currently and is set to <strong id="CreateBigkeyScanTask__b92596620159">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateBigkeyScanTask__p1925910612157"><strong id="CreateBigkeyScanTask__b172592661510">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__table1325966161516" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row122598621514"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="CreateBigkeyScanTask__p142596618154">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="CreateBigkeyScanTask__p525946181512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="CreateBigkeyScanTask__p1925910612159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row825918691510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateBigkeyScanTask__p192602681516">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateBigkeyScanTask__p11260186201519">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateBigkeyScanTask__p1126013671515">Error message.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row172592615155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateBigkeyScanTask__p7260126151519">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateBigkeyScanTask__p22607611156">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateBigkeyScanTask__p1626019614152">Error code.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row1525986111518"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="CreateBigkeyScanTask__p226015615157">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="CreateBigkeyScanTask__p22605621512">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="CreateBigkeyScanTask__p182607611152">Extended error information. This parameter is not used currently and is set to <strong id="CreateBigkeyScanTask__b126086161517">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateBigkeyScanTask__p16260176181519"><strong id="CreateBigkeyScanTask__b182601563157">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__table42600651515" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="CreateBigkeyScanTask__row32601621518"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.1"><p id="CreateBigkeyScanTask__p82607614150">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.14.2.4.1.2"><p id="CreateBigkeyScanTask__p1926016151517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.14.2.4.1.3"><p id="CreateBigkeyScanTask__p142611264157">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row1826018641516"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateBigkeyScanTask__p6261166141513">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateBigkeyScanTask__p22613618150">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateBigkeyScanTask__p72613631516">Error message.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row92601962158"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateBigkeyScanTask__p10261866153">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateBigkeyScanTask__p3261196161517">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateBigkeyScanTask__p1326112621520">Error code.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row22601864151"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.1 "><p id="CreateBigkeyScanTask__p12611567157">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.14.2.4.1.2 "><p id="CreateBigkeyScanTask__p026110620153">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.14.2.4.1.3 "><p id="CreateBigkeyScanTask__p20261669157">Extended error information. This parameter is not used currently and is set to <strong id="CreateBigkeyScanTask__b142611962158">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateBigkeyScanTask__section172615610159"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="CreateBigkeyScanTask__screen426120621518">POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/bigkey-task</pre>
</div>
<div class="section" id="CreateBigkeyScanTask__section62611567157"><h4 class="sectiontitle">Example Responses</h4><p id="CreateBigkeyScanTask__p16261116171516"><strong id="CreateBigkeyScanTask__b13261666152">Status code: 200</strong></p>
<p id="CreateBigkeyScanTask__p526166171512">Big key analysis task created successfully.</p>
<pre class="screen" id="CreateBigkeyScanTask__screen112625616152">{
"id" : "858ee14c-2271-4489-8b82-7bda7459ae3e",
"instance_id" : "5f9057b5-c330-4ee2-8138-7e69896eeec3",
"status" : "waiting",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z",
"num" : 0
}</pre>
<p id="CreateBigkeyScanTask__p1926218617152"><strong id="CreateBigkeyScanTask__b19262161154">Status code: 400</strong></p>
<p id="CreateBigkeyScanTask__p326216671511">Invalid request.</p>
<pre class="screen" id="CreateBigkeyScanTask__screen2026219614157">{
"error_code" : "DCS.4919",
"error_msg" : "Does not support bigkey analyze."
}</pre>
</div>
<div class="section" id="CreateBigkeyScanTask__section18262116101512"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateBigkeyScanTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateBigkeyScanTask__row326276151512"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateBigkeyScanTask__p122631068150">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateBigkeyScanTask__p152632069151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateBigkeyScanTask__row326236191517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p9263146141510">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p62631165150">Big key analysis task created successfully.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row152621767156"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p82631565155">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p192634615155">Invalid request.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row11262196191510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p726314614156">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p172631168152">Invalid authentication information.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row11262666154"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p426356161518">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p172631863155">The request is rejected.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row12628641515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p926316631515">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p22631961155">The requested resource is not found.</p>
</td>
</tr>
<tr id="CreateBigkeyScanTask__row1326246141514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateBigkeyScanTask__p1926316691510">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateBigkeyScanTask__p10263116111516">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateBigkeyScanTask__section172631663156"><h4 class="sectiontitle">Error Codes</h4><p id="CreateBigkeyScanTask__p12631469152">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