vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/dcs-api-0514004.html
Chen, Junjie 5e34f6ce26 DCS API-REF Initial Version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2022-12-09 16:44:56 +00:00

395 lines
29 KiB
HTML
Raw Permalink Blame History

<a name="dcs-api-0514004"></a><a name="dcs-api-0514004"></a>
<h1 class="topictitle1">Creating a Data Migration Task</h1>
<div id="body1589429224196"><div class="section" id="dcs-api-0514004__section2941114420717"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0514004__p173811345873">This API is used to create a data migration task.</p>
</div>
<div class="section" id="dcs-api-0514004__section794612441779"><h4 class="sectiontitle">Constraints</h4><p id="dcs-api-0514004__p938219454714">None</p>
</div>
<div class="section" id="dcs-api-0514004__section18949444774"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0514004__p53825459720">POST /v2/{project_id}/migration-task</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table4950644775" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dcs-api-0514004__row538284512712"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="dcs-api-0514004__p8382154515713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.5.1.2"><p id="dcs-api-0514004__p338224518717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="dcs-api-0514004__p138314513720">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.3.2.5.1.4"><p id="dcs-api-0514004__p338354513714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row1538324512718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dcs-api-0514004__p1438314451675">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dcs-api-0514004__p738312452716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dcs-api-0514004__p1738354515713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dcs-api-0514004__p83831545473">Project ID.</p>
<p id="dcs-api-0514004__p6760145195318">For details about how to obtain the project ID, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dcs-api-0514004__section3973124420710"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table6983144410715" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameter description</caption><thead align="left"><tr id="dcs-api-0514004__row238494516710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="dcs-api-0514004__p1238474516718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.4.2.2.5.1.2"><p id="dcs-api-0514004__p5384645677">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="dcs-api-0514004__p133843453712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.5.1.4"><p id="dcs-api-0514004__p1384194517711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row153849451279"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p83848455715">task_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p03846451377">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p11384134516711">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p33841445279">Name of the migration task.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row193840451070"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p438417451075">description</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p173844451971">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p538444512710">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p2038419456710">Description of the migration task.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row1384164513712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p2384114517717">migration_type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p938454514718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p163853458714">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p143855451371">Mode of the migration.</p>
<p id="dcs-api-0514004__p103859451070">Options:</p>
<ul id="dcs-api-0514004__ul13385145076"><li id="dcs-api-0514004__li63856451477"><strong id="dcs-api-0514004__b174641522174">backupfile_import</strong>: indicates importing backup files.</li><li id="dcs-api-0514004__li1038534511718"><strong id="dcs-api-0514004__b0342840187">online_migration</strong>: indicates migrating data online.</li></ul>
</td>
</tr>
<tr id="dcs-api-0514004__row6385114510713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p5385545378">migration_method</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p2385184514714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p63854453710">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p113852451173">Type of the migration.</p>
<p id="dcs-api-0514004__p193852453710">Options:</p>
<ul id="dcs-api-0514004__ul133851045171"><li id="dcs-api-0514004__li0385945876"><strong id="dcs-api-0514004__b147874111182">full_amount_migration</strong>: indicates a full migration.</li><li id="dcs-api-0514004__li17385245075"><strong id="dcs-api-0514004__b9879115371813">incremental_migration</strong>: indicates an incremental migration.</li></ul>
</td>
</tr>
<tr id="dcs-api-0514004__row153851045976"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p113854455713">backup_files</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p2385845673">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p5385174519711"><a href="#dcs-api-0514004__table52620454720">BackupFilesBody</a> Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p18385144517718">Backup files to be imported when the migration mode is importing backup files.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row13851145475"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p1938584510719">network_type</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p738518451678">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p1738515451973">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p63858459715">Type of the network for communication between the source and destination Redis when the migration mode is online data migration.</p>
<p id="dcs-api-0514004__p4385164513716">Options:</p>
<ul id="dcs-api-0514004__ul143859452077"><li id="dcs-api-0514004__li5385745977"><strong id="dcs-api-0514004__b1533613261216">vpc</strong></li><li id="dcs-api-0514004__li16385645772"><strong id="dcs-api-0514004__b198889279213">vpn</strong></li></ul>
</td>
</tr>
<tr id="dcs-api-0514004__row10385174517716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p53856451973">source_instance</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p10385745971">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p33851445372"><a href="#dcs-api-0514004__table1463144520714">SourceInstanceBody</a> Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p2030614221430">Source Redis information. This parameter is mandatory when the migration mode is online data migration.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row203861545371"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dcs-api-0514004__p43863450717">target_instance</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dcs-api-0514004__p1738612452716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dcs-api-0514004__p538618455715"><a href="#dcs-api-0514004__table147217451875">TargetInstanceBody</a> Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dcs-api-0514004__p2038611451978">Destination Redis instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0514004__table52620454720"></a><a name="table52620454720"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table52620454720" frame="border" border="1" rules="all"><caption><b>Table 3 </b>BackupFilesBody</caption><thead align="left"><tr id="dcs-api-0514004__row83863451572"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="dcs-api-0514004__p9386184516714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.4.3.2.5.1.2"><p id="dcs-api-0514004__p1138644510717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="dcs-api-0514004__p173861451177">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.5.1.4"><p id="dcs-api-0514004__p93868451976">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row153861045179"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dcs-api-0514004__p16386745776">file_source</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dcs-api-0514004__p1338620451871">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dcs-api-0514004__p138616451971">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dcs-api-0514004__p193869452713">Data source. Currently, only OBS buckets are supported. The value is <strong id="dcs-api-0514004__b112240577276">self_build_obs</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row13864451776"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dcs-api-0514004__p738617455716">bucket_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dcs-api-0514004__p238616458719">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dcs-api-0514004__p1838620451975">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dcs-api-0514004__p143864451679">OBS bucket name.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row538611451719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dcs-api-0514004__p103864451771">files</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dcs-api-0514004__p203866451071">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dcs-api-0514004__p239963593712">Array of <a href="#dcs-api-0514004__table4440451079">Files</a> Objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dcs-api-0514004__p438674512719">List of backup files to be imported.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0514004__table4440451079"></a><a name="table4440451079"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table4440451079" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Files</caption><thead align="left"><tr id="dcs-api-0514004__row1438611451775"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="dcs-api-0514004__p1538714454710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.4.4.2.5.1.2"><p id="dcs-api-0514004__p1387164516720">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="dcs-api-0514004__p3387445275">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.5.1.4"><p id="dcs-api-0514004__p2387145978">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row1138719451572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dcs-api-0514004__p938754519715">file_name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dcs-api-0514004__p133877451975">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dcs-api-0514004__p9387164511716">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dcs-api-0514004__p53876457714">Name of a backup file.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row10387174516719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dcs-api-0514004__p1038718458711">size</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dcs-api-0514004__p113876454712">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dcs-api-0514004__p83879453716">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dcs-api-0514004__p113872451172">File size in bytes.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row1738711456718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dcs-api-0514004__p173871045276">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dcs-api-0514004__p153874459715">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dcs-api-0514004__p163874458713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dcs-api-0514004__p11387134515714">Time when the file is last modified. The format is YYYY-MM-DD HH:MM:SS.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0514004__table1463144520714"></a><a name="table1463144520714"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table1463144520714" frame="border" border="1" rules="all"><caption><b>Table 5 </b>SourceInstanceBody</caption><thead align="left"><tr id="dcs-api-0514004__row1538717451270"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="dcs-api-0514004__p19387845276">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.4.5.2.5.1.2"><p id="dcs-api-0514004__p143877451170">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="dcs-api-0514004__p3387345877">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.5.1.4"><p id="dcs-api-0514004__p10387144510715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row19387124515714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dcs-api-0514004__p738711452712">addrs</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dcs-api-0514004__p338710451074">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dcs-api-0514004__p83871645371">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dcs-api-0514004__p638712453710">Source Redis name (specified in the <strong id="dcs-api-0514004__b75417083014">source_instance</strong> parameter).</p>
</td>
</tr>
<tr id="dcs-api-0514004__row83871945874"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="dcs-api-0514004__p19387245573">password</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.5.2.5.1.2 "><p id="dcs-api-0514004__p838718451779">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="dcs-api-0514004__p23878451171">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.5.1.4 "><p id="dcs-api-0514004__p9387154515712">Redis password. If a password is set, this parameter is mandatory.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0514004__table147217451875"></a><a name="table147217451875"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table147217451875" frame="border" border="1" rules="all"><caption><b>Table 6 </b>TargetInstanceBody</caption><thead align="left"><tr id="dcs-api-0514004__row1038716451079"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="dcs-api-0514004__p183871459714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.4.6.2.5.1.2"><p id="dcs-api-0514004__p738817451679">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.3"><p id="dcs-api-0514004__p133880454717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.5.1.4"><p id="dcs-api-0514004__p103881645173">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row1938844510716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dcs-api-0514004__p938812451775">id</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dcs-api-0514004__p1138818451573">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dcs-api-0514004__p17388445679">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dcs-api-0514004__p03885455719">Destination Redis instance ID (mandatory in the <strong id="dcs-api-0514004__b094145163013">target_instance</strong> parameter).</p>
</td>
</tr>
<tr id="dcs-api-0514004__row203888451473"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dcs-api-0514004__p638812452720">name</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dcs-api-0514004__p103883451478">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dcs-api-0514004__p338819451678">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dcs-api-0514004__p113889458715">Destination Redis instance name (specified in the <strong id="dcs-api-0514004__b226662133118">target_instance</strong> parameter).</p>
</td>
</tr>
<tr id="dcs-api-0514004__row13881545579"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dcs-api-0514004__p93881345376">password</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dcs-api-0514004__p238814511716">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dcs-api-0514004__p538819451471">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dcs-api-0514004__p1038815459716">Redis password. If a password is set, this parameter is mandatory.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dcs-api-0514004__section1185204515719"><h4 class="sectiontitle">Response</h4><p id="dcs-api-0514004__p83881945077">If the status code is 200, the following parameters are returned:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table189211455719" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0514004__row16389045975"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="dcs-api-0514004__p1638916451971">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="dcs-api-0514004__p1238912452716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="dcs-api-0514004__p4389174516718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row2038911451174"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="dcs-api-0514004__p238964513712">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="dcs-api-0514004__p538917458710">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="dcs-api-0514004__p638913457710">ID of the migration task.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row338964515718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="dcs-api-0514004__p17389204518712">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="dcs-api-0514004__p17389154517713">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="dcs-api-0514004__p1138944515713">Name of the migration task.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row2038919451878"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="dcs-api-0514004__p183897451974">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="dcs-api-0514004__p23898454718">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="dcs-api-0514004__p138462211818">Migration task status. The value can be:</p>
<ul id="dcs-api-0514004__ul03847221185"><li id="dcs-api-0514004__li133842225820"><strong id="dcs-api-0514004__b5126194945712">SUCCESS</strong>: Migration succeeded.</li><li id="dcs-api-0514004__li163842229816"><strong id="dcs-api-0514004__b1736417538577">FAILED</strong>: Migration failed.</li><li id="dcs-api-0514004__li1138412221811"><strong id="dcs-api-0514004__b148721159195712">MIGRATING</strong>: Migration is in progress.</li><li id="dcs-api-0514004__li103856228819"><strong id="dcs-api-0514004__b94020519586">TERMINATED</strong>: Migration has been stopped.</li><li id="dcs-api-0514004__li33900100515"><strong id="dcs-api-0514004__b13545201613582">TERMINATING</strong>: Migration is being stopped.</li><li id="dcs-api-0514004__li20211455161"><strong id="dcs-api-0514004__b2766105719580">RUNNING</strong>: The migration task has been created and is waiting to be executed.</li><li id="dcs-api-0514004__li16325511579"><strong id="dcs-api-0514004__b539421816594">CREATING</strong>: The migration task is being created.</li><li id="dcs-api-0514004__li9638144921311"><strong id="dcs-api-0514004__b029315368592">FULLMIGRATING</strong>: Full migration is in progress.</li><li id="dcs-api-0514004__li57481956161315"><strong id="dcs-api-0514004__b1515119455590">INCRMIGEATING</strong>: Incremental migration is in progress.</li><li id="dcs-api-0514004__li104374671413"><strong id="dcs-api-0514004__b11431205016594">ERROR</strong>: faulty</li><li id="dcs-api-0514004__li651714141417"><strong id="dcs-api-0514004__b1988095413594">DELETED</strong>: faulty</li><li id="dcs-api-0514004__li14587192015142"><strong id="dcs-api-0514004__b134306582596">RELEASED</strong>: automatically released</li><li id="dcs-api-0514004__li1322415293141"><strong id="dcs-api-0514004__b0169726015">MIGRATION_SUCCESS</strong>: The migration is successful, and resources are to be cleared.</li><li id="dcs-api-0514004__li167761435101414"><strong id="dcs-api-0514004__b8785136803">MIGRATION_FAILED</strong>: The migration failed, and resources are to be cleared.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dcs-api-0514004__section141051845378"><h4 class="sectiontitle">Example Request</h4><ul id="dcs-api-0514004__ul1822194415523"><li id="dcs-api-0514004__li722444185216">Example request URL:<pre class="screen" id="dcs-api-0514004__screen1469117611335">POST https://{dcs_endpoint}/v2/{project_id}/migration-task</pre>
</li><li id="dcs-api-0514004__li1865938538">Example request 1 (online migration)<pre class="screen" id="dcs-api-0514004__screen157589719316">{
"task_name" : "lmd-test",
"description" : "Test",
"migration_type" : "online_migration",
"migration_method" : "full_amount_migration",
"network_type" : "vpc",
"source_instance" : {
"addrs" : "192.168.1.135:6379",
"password" : "xxxxxx"
},
"target_instance" : {
"name" : "dcs-test",
"id" : "4cd5dbb8-aacd-4603-b817-3e97d48c7a20"
}
}</pre>
</li><li id="dcs-api-0514004__li13766131110471">Example request 2 (importing a backup file)<pre class="screen" id="dcs-api-0514004__screen1318025974420">{
"backup_files": {
"bucket_name": "bucket-lmz",
"file_source": "self_build_obs",
"files": [
{
"file_name": "appendonly03.aof"
}
]
},
"migration_method": "full_amount_migration",
"migration_type": "backupfile_import",
"target_instance": {
"id": "318ed365-3c1b-42d7-a5b6-663dded628a0"
},
"task_name": "lmd-test"
}</pre>
</li></ul>
</div>
<div class="section" id="dcs-api-0514004__section1011115451179"><h4 class="sectiontitle">Example Response</h4><p id="dcs-api-0514004__p20389114515714">If the status code is 200, the data migration task is successfully created.</p>
<pre class="screen" id="dcs-api-0514004__screen44096553332">{
"id" : "8aa6999e71cb638b0171f485f5266ef0",
"name" : "lmd-test",
"status" : "MIGRATING"
}</pre>
</div>
<div class="section" id="dcs-api-0514004__section311554516711"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0514004__table611512451875" frame="border" border="1" rules="all"><thead align="left"><tr id="dcs-api-0514004__row1338919457713"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="dcs-api-0514004__p12389124514712">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="dcs-api-0514004__p939017451712">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0514004__row339016451072"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="dcs-api-0514004__p17390845174">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="dcs-api-0514004__p639014451279">Data migration task created successfully.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row1039044513719"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="dcs-api-0514004__p1639019452713">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="dcs-api-0514004__p13390174513719">Invalid request.</p>
</td>
</tr>
<tr id="dcs-api-0514004__row639017455718"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="dcs-api-0514004__p193906456713">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="dcs-api-0514004__p183905451777">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dcs-api-0514004__section51221454716"><h4 class="sectiontitle">Error Codes</h4><p id="dcs-api-0514004__p103901845475">For details, see <a href="dcs-api-0312044.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0514003.html">Data Migration APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink