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

347 lines
27 KiB
HTML
Raw Blame History

<a name="CreateAutoExpireScanTask"></a><a name="CreateAutoExpireScanTask"></a>
<h1 class="topictitle1">Creating an Expired Key Scan Task</h1>
<div id="body1708331107508"><div class="section" id="CreateAutoExpireScanTask__section5876157121814"><h4 class="sectiontitle">Function</h4><p id="CreateAutoExpireScanTask__p9876557111814">This API is used to create an expired key scan task.</p>
<p id="CreateAutoExpireScanTask__p78761157141810">The keyspace will be scanned to release the memory used by expired keys that were not released due to the lazy free mechanism.</p>
<p id="CreateAutoExpireScanTask__p18761357141817">This scan is on the master node of the instance and will affect instance performance. Perform this operation during off-peak hours.</p>
</div>
<div class="section" id="CreateAutoExpireScanTask__section387695714186"><h4 class="sectiontitle">URI</h4><p id="CreateAutoExpireScanTask__p1887645751810">POST /v2/{project_id}/instances/{instance_id}/scan-expire-keys-task</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__table38775572189" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row12876125716181"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateAutoExpireScanTask__p19877205781812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateAutoExpireScanTask__p138771557131812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateAutoExpireScanTask__p13877457131819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateAutoExpireScanTask__p138771757131810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row78761357131813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateAutoExpireScanTask__p3877185731815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateAutoExpireScanTask__p3877557131819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateAutoExpireScanTask__p5877857191814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateAutoExpireScanTask__p1787715578181">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row18876195710185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateAutoExpireScanTask__p188771957191816">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateAutoExpireScanTask__p198771574183">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateAutoExpireScanTask__p1587716574184">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateAutoExpireScanTask__p887865711183">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateAutoExpireScanTask__section4878165713180"><h4 class="sectiontitle">Request Parameters</h4><p id="CreateAutoExpireScanTask__p987811575183">None</p>
</div>
<div class="section" id="CreateAutoExpireScanTask__section14878195720183"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateAutoExpireScanTask__p13878125771818"><strong id="CreateAutoExpireScanTask__b14878157191812">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__response_AutoExpireScanHistoryDetailResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row18878185710185"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateAutoExpireScanTask__p12878165717186">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateAutoExpireScanTask__p1987975713182">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateAutoExpireScanTask__p78791057111814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row128781457121816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p187910578188">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p13879165712183">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p18879205720186">Expired key scan ID.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row17878757191818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p8879857101817">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1879175720188">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p1879105717186">Instance ID.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row3878125719186"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p138798577182">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p5879557171819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p0879105713182">Scan task status. Value range:</p>
<ul id="CreateAutoExpireScanTask__ul06615281148"><li id="CreateAutoExpireScanTask__li12661202831415"><strong id="CreateAutoExpireScanTask__b916914312216">waiting</strong></li><li id="CreateAutoExpireScanTask__li366112851416"><strong id="CreateAutoExpireScanTask__b31701831132116">running</strong></li><li id="CreateAutoExpireScanTask__li1966218281148"><strong id="CreateAutoExpireScanTask__b1170731132118">success</strong></li><li id="CreateAutoExpireScanTask__li26621928151411"><strong id="CreateAutoExpireScanTask__b8171103132110">failed</strong></li></ul>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row88781657111814"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p287918570185">scan_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p14879145711817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p1879175741815">Scan mode. Value range:</p>
<ul id="CreateAutoExpireScanTask__ul33881240111911"><li id="CreateAutoExpireScanTask__li83881540121913"><strong id="CreateAutoExpireScanTask__b4602204710204">manual</strong></li><li id="CreateAutoExpireScanTask__li19388144031918"><strong id="CreateAutoExpireScanTask__b760224712019">auto</strong></li></ul>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1587845781813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1987935712181">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1587915711812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p9879457101812">Time when a scan task is created. The format is <strong id="CreateAutoExpireScanTask__b168791857181811">2020-06-15T02:21:18.669Z</strong>.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row178781575184"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p20879957141819">started_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p08790577180">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p98804571187">Time when a scan task started. The format is <strong id="CreateAutoExpireScanTask__b208801857161820">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateAutoExpireScanTask__b48801357181819">null</strong> and is not returned when the scan task is being created.)</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1587814572181"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1288013578189">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1988019578182">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateAutoExpireScanTask__p6880165771813">Time when a scan task ended. The format is <strong id="CreateAutoExpireScanTask__b18880757131811">2020-06-15T02:21:18.669Z</strong>. (The value is <strong id="CreateAutoExpireScanTask__b588085741812">null</strong> and is not returned when the scan task is being created.)</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateAutoExpireScanTask__p38801457101818"><strong id="CreateAutoExpireScanTask__b1088095771815">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row488005751816"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="CreateAutoExpireScanTask__p178809579187">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="CreateAutoExpireScanTask__p16880105731816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="CreateAutoExpireScanTask__p10880457161812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row108801257121816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateAutoExpireScanTask__p10880105715183">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1188015712182">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateAutoExpireScanTask__p2088012572182">Error message.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row68801257151816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateAutoExpireScanTask__p138801657161820">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateAutoExpireScanTask__p4880195711183">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateAutoExpireScanTask__p7881205711813">Error code.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1188014575183"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateAutoExpireScanTask__p68811557161819">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateAutoExpireScanTask__p138812057171817">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateAutoExpireScanTask__p128818571189">Extended error information. This parameter is not used currently and is set to <strong id="CreateAutoExpireScanTask__b38811057191818">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateAutoExpireScanTask__p17881357101811"><strong id="CreateAutoExpireScanTask__b11881195771818">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__table13881125721810" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row14881145720181"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="CreateAutoExpireScanTask__p16881657161813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="CreateAutoExpireScanTask__p388120579189">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="CreateAutoExpireScanTask__p1588105741810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row08811557121819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateAutoExpireScanTask__p388185721820">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1688165721815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateAutoExpireScanTask__p16881457171814">Error message.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row128813572186"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateAutoExpireScanTask__p17881195711819">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateAutoExpireScanTask__p08812057131814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateAutoExpireScanTask__p4882125761814">Error code.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1588155701818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateAutoExpireScanTask__p15882105714184">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1088219579183">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateAutoExpireScanTask__p12882115751817">Extended error information. This parameter is not used currently and is set to <strong id="CreateAutoExpireScanTask__b17882195712183">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateAutoExpireScanTask__p28822057111815"><strong id="CreateAutoExpireScanTask__b1688225791816">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__table1882115712181" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row18882557121814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="CreateAutoExpireScanTask__p128821957111811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="CreateAutoExpireScanTask__p10882105711184">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="CreateAutoExpireScanTask__p11882135751812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row13882145771816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateAutoExpireScanTask__p2882157121813">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateAutoExpireScanTask__p6882105741814">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateAutoExpireScanTask__p168821957191817">Error message.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row688218579185"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateAutoExpireScanTask__p13882557111810">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1888213572183">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateAutoExpireScanTask__p6882157121813">Error code.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row15882957161810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateAutoExpireScanTask__p178821857131816">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1688395781819">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateAutoExpireScanTask__p2883115701815">Extended error information. This parameter is not used currently and is set to <strong id="CreateAutoExpireScanTask__b178831657171816">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateAutoExpireScanTask__p15883125711818"><strong id="CreateAutoExpireScanTask__b1688315710189">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__table178831857191818" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row1088335701816"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="CreateAutoExpireScanTask__p1388313573183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="CreateAutoExpireScanTask__p588315575182">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="CreateAutoExpireScanTask__p688315712180">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row1288311576181"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateAutoExpireScanTask__p11883557131814">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1488305717187">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateAutoExpireScanTask__p198831357131818">Error message.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1488315781810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1388325718188">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateAutoExpireScanTask__p17883125751816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateAutoExpireScanTask__p388345710182">Error code.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row688311570183"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1883105731815">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="CreateAutoExpireScanTask__p158841457131810">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="CreateAutoExpireScanTask__p10884185717189">Extended error information. This parameter is not used currently and is set to <strong id="CreateAutoExpireScanTask__b10884195710184">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="CreateAutoExpireScanTask__p15884105712189"><strong id="CreateAutoExpireScanTask__b68841457141810">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__table5884205717182" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateAutoExpireScanTask__row88841057171812"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.1"><p id="CreateAutoExpireScanTask__p1884125711186">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.2"><p id="CreateAutoExpireScanTask__p58841957101817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.13.2.4.1.3"><p id="CreateAutoExpireScanTask__p16884115781816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row10884957181817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateAutoExpireScanTask__p10884185761818">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateAutoExpireScanTask__p1088485714186">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateAutoExpireScanTask__p78841857181815">Error message.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row1688412572189"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1888495771812">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateAutoExpireScanTask__p158841457161812">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateAutoExpireScanTask__p1988415718185">Error code.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row08849576186"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="CreateAutoExpireScanTask__p1488455720184">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="CreateAutoExpireScanTask__p178851657171816">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="CreateAutoExpireScanTask__p8885145781811">Extended error information. This parameter is not used currently and is set to <strong id="CreateAutoExpireScanTask__b178851357171819">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateAutoExpireScanTask__section588517578183"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="CreateAutoExpireScanTask__screen1488555771815">POST https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/scan-expire-keys-task</pre>
</div>
<div class="section" id="CreateAutoExpireScanTask__section168852578183"><h4 class="sectiontitle">Example Responses</h4><p id="CreateAutoExpireScanTask__p888555731813"><strong id="CreateAutoExpireScanTask__b688555711186">Status code: 200</strong></p>
<p id="CreateAutoExpireScanTask__p1788555716184">Expired key scan task created successfully.</p>
<pre class="screen" id="CreateAutoExpireScanTask__screen188855573185">{
"id" : "aa735b6f-3d70-44e3-9771-66c6fae7459a",
"instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
"status" : "waiting",
"scan_type" : "manual",
"created_at" : "2020-06-15T02:21:18.669Z"
}</pre>
<p id="CreateAutoExpireScanTask__p118852577189"><strong id="CreateAutoExpireScanTask__b12885185715185">Status code: 400</strong></p>
<p id="CreateAutoExpireScanTask__p16885185710182">Invalid request.</p>
<pre class="screen" id="CreateAutoExpireScanTask__screen1988545714182">{
"error_code" : "DCS.4818",
"error_msg" : "Do not support auto expire scan."
}</pre>
</div>
<div class="section" id="CreateAutoExpireScanTask__section208851957111817"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateAutoExpireScanTask__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateAutoExpireScanTask__row19886205731819"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateAutoExpireScanTask__p17886145716182">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateAutoExpireScanTask__p1688625711811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateAutoExpireScanTask__row38867572189"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p1288615570189">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p5886115716182">Expired key scan task created successfully.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row48861857201820"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p3886145710184">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p18886195713183">Invalid request.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row168861857171811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p1188675731813">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p128861157111812">Invalid authentication information.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row5886105731814"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p78861457201814">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p0886145716186">Request rejected.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row5886195711811"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p588695713184">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p1588655719181">The requested resource could not be found.</p>
</td>
</tr>
<tr id="CreateAutoExpireScanTask__row98861575187"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateAutoExpireScanTask__p168861257151814">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateAutoExpireScanTask__p1588611573185">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateAutoExpireScanTask__section1688625771819"><h4 class="sectiontitle">Error Codes</h4><p id="CreateAutoExpireScanTask__p188755741810">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