vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/drs/api-ref/drs_03_0104.html
Ru, Li Yi 9c5f69ed88 drs_api_20240415 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-04-22 18:20:28 +00:00

769 lines
56 KiB
HTML
Raw Blame History

<a name="drs_03_0104"></a><a name="drs_03_0104"></a>
<h1 class="topictitle1">Creating Tasks in Batches</h1>
<div id="body23173410452"><div class="section" id="drs_03_0104__section13179444510"><h4 class="sectiontitle">Function</h4><p id="drs_03_0104__p19318104114519">This API is used to create real-time migration, real-time synchronization, and real-time DR tasks in batches based on different request parameters.</p>
</div>
<div class="section" id="drs_03_0104__section43185414458"><h4 class="sectiontitle">URI</h4><p id="drs_03_0104__p331811414515">POST /v3/{project_id}/jobs/batch-creation</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__table9320044454" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0104__row6320345452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="drs_03_0104__p5321943458">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="drs_03_0104__p10321164194512">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="drs_03_0104__p1532274184515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="drs_03_0104__p932294174516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row93209416453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="drs_03_0104__p13226413455">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="drs_03_0104__p6322164144516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="drs_03_0104__p83227404512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="drs_03_0104__p113234420457">Project ID of a tenant in a region</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0104__section232313494519"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0104__row6323149454"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="drs_03_0104__p173246424517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="drs_03_0104__p173245410455">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="drs_03_0104__p16324134174519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="drs_03_0104__p173244414514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row83230494513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_03_0104__p232504114519">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_03_0104__p13254434514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_03_0104__p20325745455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_03_0104__p38658108135">The content type.</p>
<p id="drs_03_0104__p123256415450">The default value is <strong id="drs_03_0104__b146671924317">application/json</strong>.</p>
</td>
</tr>
<tr id="drs_03_0104__row20323184154512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_03_0104__p83256412455">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_03_0104__p232514418451">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_03_0104__p332617410455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_03_0104__p232614410455">User token obtained from IAM.</p>
</td>
</tr>
<tr id="drs_03_0104__row1032344124511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_03_0104__p193263411451">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_03_0104__p11326194114517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_03_0104__p12326442459">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_03_0104__p1032614494513">Request language type. The default value is <strong id="drs_03_0104__b710894032412">en-us</strong>.</p>
<p id="drs_03_0104__p1386915625912">Values:</p>
<ul id="drs_03_0104__ul1586965613591"><li id="drs_03_0104__li1886915655910"><strong id="drs_03_0104__b158691656145912">en-us</strong></li><li id="drs_03_0104__li17869125685916"><strong id="drs_03_0104__b12869175615914">zh-cn</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0104__row1432719454512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0104__p133272411451">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="drs_03_0104__p532784144511">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="drs_03_0104__p1032816418453">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="drs_03_0104__p1832810494510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row5327134204512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0104__p18328194164512">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0104__p13299420453">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0104__p163291545455">Array of <a href="#drs_03_0104__request_CreateJobReq">CreateJobReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0104__p13296444512">Request body for creating tasks.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0104__request_CreateJobReq"></a><a name="request_CreateJobReq"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__request_CreateJobReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateJobReq</caption><thead align="left"><tr id="drs_03_0104__row133301841452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="drs_03_0104__p103315417454">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.3.4.2.5.1.2"><p id="drs_03_0104__p5331114184516">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.03%" id="mcps1.3.3.4.2.5.1.3"><p id="drs_03_0104__p8331245454">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="drs_03_0104__p43310419459">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row103303410451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p93313424510">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p133320464514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p163323411459">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p203328419454">The task name. The task name can be 4 to 50 characters in length. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
<ul id="drs_03_0104__ul18937471185"><li id="drs_03_0104__li9937771984">Minimum length: <strong id="drs_03_0104__b4339182311467">4</strong> characters</li><li id="drs_03_0104__li159373715815">Maximum length: <strong id="drs_03_0104__b184621330174616">50</strong> characters</li></ul>
</td>
</tr>
<tr id="drs_03_0104__row233017414456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p8332194184511">db_use_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p183338411456">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p13331646456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p11594726171013">Migration scenario.</p>
<p id="drs_03_0104__p175919201492">Values:</p>
<ul id="drs_03_0104__ul156011201593"><li id="drs_03_0104__li186010201893"><strong id="drs_03_0104__b17762658204613">migration</strong>: real-time migration.</li><li id="drs_03_0104__li11601920998"><strong id="drs_03_0104__b198878311479">sync</strong>: real-time synchronization.</li><li id="drs_03_0104__li9601620094"><strong id="drs_03_0104__b08878514473">cloudDataGuard</strong>: real-time disaster recovery.</li></ul>
</td>
</tr>
<tr id="drs_03_0104__row133301443458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p193346414457">engine_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p1933410424511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p133419414513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p19186752194515">Engine type of a DRS task.</p>
<p id="drs_03_0104__p1162920594">Values:</p>
<ul id="drs_03_0104__ul16212201793"><li id="drs_03_0104__li1362142019913"><strong id="drs_03_0104__b14562011134815">mysql</strong>: used for migration and synchronization from MySQL to MySQL</li><li id="drs_03_0104__li8621920593"><strong id="drs_03_0104__b854125074813">mongodb</strong>: used for migration from MongoDB to DDS</li><li id="drs_03_0104__li1062920091"><strong id="drs_03_0104__b1373111145114">cloudDataGuard-mysql</strong>: used for DR from MySQL to MySQL</li><li id="drs_03_0104__li1964604714212"><strong id="drs_03_0104__b1480114111532">mysql-to-taurus</strong>: used for synchronization from MySQL to GaussDB(for MySQL) primary/standby</li><li id="drs_03_0104__li0352957122719"><strong id="drs_03_0104__b1860582935411">postgresql</strong>: used for synchronization from PostgreSQL to PostgreSQL</li></ul>
</td>
</tr>
<tr id="drs_03_0104__row9330442458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p33358404513">job_direction</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p10335144124520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p123352434514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p296873019405">Task direction.</p>
<p id="drs_03_0104__p46472019911">Values:</p>
<ul id="drs_03_0104__ul564132015915"><li id="drs_03_0104__li10649206912"><strong id="drs_03_0104__b1086374304616">up</strong>: to-the-cloud scenarios and the current cloud is the standby cloud in the DR.</li><li id="drs_03_0104__li19641201794"><strong id="drs_03_0104__b18765351605">down</strong>: out-of-cloud scenarios and the current cloud is the active cloud in the DR.</li><li id="drs_03_0104__li2064142016914"><strong id="drs_03_0104__b898714231306">non-dbs</strong>: self-built databases.</li></ul>
</td>
</tr>
<tr id="drs_03_0104__row1433014416458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p173361544456">bind_eip</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p93364418451">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p53361445457">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p113368484516">Whether to bind an EIP. This parameter is mandatory and set to <strong id="drs_03_0104__b1617411303186">true</strong> when the network type is EIP.</p>
</td>
</tr>
<tr id="drs_03_0104__row333074174511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p1333614417454">customize_sutnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p1833715494518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p733716416453">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p1653292312417">The ID of the subnet where the DRS instance resides, which corresponds to the network ID of the subnet created in the VPC of the destination database. The value is in UUID format.</p>
</td>
</tr>
<tr id="drs_03_0104__row113301647453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p033718416459">is_target_readonly</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p533734174515">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p7337184174515">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p133854144513">Whether the destination DB instance can be read-only. This parameter is valid only when the destination DB instance is a MySQL DB instance and the<strong id="drs_03_0104__b673314613206"> job_direction</strong> value is <strong id="drs_03_0104__b15934199152011">up</strong>. In the DR scenario, this parameter is mandatory and set to <strong id="drs_03_0104__b121871214142111">true</strong> if the current cloud is a standby cloud. If this parameter is not specified, the default value is <strong id="drs_03_0104__b211414299213">true</strong>.</p>
</td>
</tr>
<tr id="drs_03_0104__row2330154174513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p93388411456">net_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p6338142456">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p18338164134514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p1833854104517">Network type. Value:</p>
<ul id="drs_03_0104__ul13381343458"><li id="drs_03_0104__li153381414514"><strong id="drs_03_0104__b1933819411450">vpn</strong></li><li id="drs_03_0104__li9338154124515"><strong id="drs_03_0104__b153396474519">vpc</strong></li><li id="drs_03_0104__li83391414519"><strong id="drs_03_0104__b153392046451">eip</strong></li></ul>
<p id="drs_03_0104__p1277240175017">The VPC network cannot be selected in the DR scenario.</p>
</td>
</tr>
<tr id="drs_03_0104__row113301749455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p153391747454">node_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p03399410459">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p4339446455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p1033919410452">The flavor type. Value:</p>
<ul id="drs_03_0104__ul183392484519"><li id="drs_03_0104__li1833918414516"><strong id="drs_03_0104__b183404420457">high</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0104__row1570148165313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p6570148145313">node_num</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p4570148105312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p115701181535">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p2667134412715">The number of nodes.</p>
<p id="drs_03_0104__p1924114488534">For a MongoDB database, this parameter indicates the number of source shards. This parameter is mandatory when the source database is a cluster. The value ranges from 1 to 32. The default value is <strong id="drs_03_0104__b0120513548">2</strong> for MySQL dual-active DR.</p>
</td>
</tr>
<tr id="drs_03_0104__row1833004194519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p103407415454">source_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p133409464512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p83407464516"><a href="#drs_03_0104__request_Endpoint">Endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p163401947457">The source database information.</p>
</td>
</tr>
<tr id="drs_03_0104__row12330114164517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p103401746453">target_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p133401445455">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p4341174124511"><a href="#drs_03_0104__request_Endpoint">Endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p134113418453">The destination database information.</p>
</td>
</tr>
<tr id="drs_03_0104__row153304474512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p1534134174517">task_type</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p16341246451">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p93412414510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p57120209918">Task mode. The default value is <strong id="drs_03_0104__b105659510917">FULL_INCR_TRANS</strong>.</p>
<p id="drs_03_0104__p271192011914">Values:</p>
<ul id="drs_03_0104__ul27119201191"><li id="drs_03_0104__li167192011915"><strong id="drs_03_0104__b325510345911">FULL_TRANS</strong>: full migration</li><li id="drs_03_0104__li771142018919"><strong id="drs_03_0104__b4805153713919">FULL_INCR_TRANS</strong>: full+incremental migration</li><li id="drs_03_0104__li187115203910"><strong id="drs_03_0104__b154114017918">INCR_TRANS</strong>: incremental migration</li></ul>
<p id="drs_03_0104__p165423913109">In the single-active DR scenario, only <strong id="drs_03_0104__b1355667111014">FULL_INCR_TRANS</strong> is available.</p>
</td>
</tr>
<tr id="drs_03_0104__row1533018484513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p133421848451">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p143424484516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p934204164518">Array of <a href="#drs_03_0104__request_ResourceTag">ResourceTag</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p81429176527">Tag information. Up to 20 tags can be added.</p>
</td>
</tr>
<tr id="drs_03_0104__row23302494519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p2343164104519">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p20343841451">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p183438404513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p934311416451">Task description. The task description can contain a maximum of 256 characters and cannot contain the following special characters: !&lt;&gt;'&amp;"\</p>
</td>
</tr>
<tr id="drs_03_0104__row20330204184519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p193435410453">multi_write</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p10344154114511">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p113441743455">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="drs_03_0104__ul1334411414450"><li id="drs_03_0104__li193444444519">This parameter is mandatory when <strong id="drs_03_0104__b766510509302">db_use_type</strong> is set to <strong id="drs_03_0104__b1993019013118">cloudDataGuard</strong>. If the DR type is dual-active, the value of <strong id="drs_03_0104__b1685463611312">multi_write</strong> is <strong id="drs_03_0104__b4925163819315">true</strong>. Otherwise, the value is <strong id="drs_03_0104__b132523431313">false</strong>.</li><li id="drs_03_0104__li1034411434512">If <strong id="drs_03_0104__b194881850163118">db_use_type</strong> is set to other values, <strong id="drs_03_0104__b13742056133111">multi_write</strong> is optional.</li></ul>
<p id="drs_03_0104__p143442454515">Default value: <strong id="drs_03_0104__b1251625910315">false</strong></p>
</td>
</tr>
<tr id="drs_03_0104__row06641914194510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p566412146451">sys_tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p5664114144510">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p86648140456">Array of <a href="#drs_03_0104__request_ResourceTag">ResourceTag</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p18664111419453">Enterprise project. If this parameter is not specified, the value is <strong id="drs_03_0104__b4119162415338">default</strong>. The <strong id="drs_03_0104__b085411514018">key</strong> must be <strong id="drs_03_0104__b575093619335">_sys_enterprise_project_id</strong>, and the <strong id="drs_03_0104__b1256671912406">value</strong> is the enterprise project ID. Only one enterprise project can be selected.</p>
</td>
</tr>
<tr id="drs_03_0104__row48865312280"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p10886113192814">expired_days</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p10886103119283">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p488611317288">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p178861431182819">After a task is in the abnormal status for a period of time, the task is automatically stopped. The unit is day. The value ranges from 14 to 100. If this parameter is not transferred, the default value is <strong id="drs_03_0104__b9174203319494">14</strong>.</p>
</td>
</tr>
<tr id="drs_03_0104__row9214205116148"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p8234181217145">master_az</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p19234111220145">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p123591211418">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p1823517127148">AZ where the primary task is located. You can obtain the value by calling the API for querying AZs where flavors are not sold out.</p>
<ul id="drs_03_0104__ul1323531214148"><li id="drs_03_0104__li1323571212144">This parameter takes effect when both <strong id="drs_03_0104__b1289271016013">master_az</strong> and <strong id="drs_03_0104__b969149018">slave_az</strong> are specified.</li><li id="drs_03_0104__li1923511218144">MySQL are supported.</li></ul>
</td>
</tr>
<tr id="drs_03_0104__row659925531413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_03_0104__p1023512129149">slave_az</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_03_0104__p14235012161420">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.03%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_03_0104__p323617123147">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_03_0104__p4236161213145">AZ where the standby task is located. You can obtain the value by calling the API for querying AZs where flavors are not sold out.</p>
<ul id="drs_03_0104__ul11236111221416"><li id="drs_03_0104__li202361512121417">This parameter takes effect when both <strong id="drs_03_0104__b974734151511">master_az</strong> and <strong id="drs_03_0104__b13748154141518">slave_az</strong> are specified.</li><li id="drs_03_0104__li15236212171420">MySQL are supported.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0104__request_Endpoint"></a><a name="request_Endpoint"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__request_Endpoint" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Endpoint</caption><thead align="left"><tr id="drs_03_0104__row1134594144511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="drs_03_0104__p33470416459">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="drs_03_0104__p1034714494510">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="drs_03_0104__p19347104164513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="drs_03_0104__p234710419458">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row1134511424518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p83479412459">db_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p93470484511">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p153488411456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p14348134154513">Database type. Values:</p>
<ul id="drs_03_0104__ul134815414517"><li id="drs_03_0104__li83489412453"><strong id="drs_03_0104__b153480474518">mysql</strong></li><li id="drs_03_0104__li10348146457"><strong id="drs_03_0104__b2348164124513">mongodb</strong></li><li id="drs_03_0104__li237125601915"><strong id="drs_03_0104__b2511926162018">taurus</strong></li></ul>
<ul id="drs_03_0104__ul1490234791618"><li id="drs_03_0104__li134671052114713"><strong id="drs_03_0104__b9467752164717">postgresql</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0104__row143469414519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p1234812474511">az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p193487484517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p19349124174513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p183494417457">azCode of the AZ where the database is located.</p>
</td>
</tr>
<tr id="drs_03_0104__row143460418459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p193494412453">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p1334914412455">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p6349164164517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p134944124516">Region where the DB instance is located. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance. In DR scenarios, if <strong id="drs_03_0104__b1948614331215">job_direction</strong> is set to <strong id="drs_03_0104__b874812716121">down</strong>, this parameter is mandatory in <strong id="drs_03_0104__b66829133118">source_endpoint</strong>. If <strong id="drs_03_0104__b1498311917138">job_direction</strong> is set to <strong id="drs_03_0104__b4919046141410">up</strong>, this parameter is mandatory in <strong id="drs_03_0104__b654231871117">target_endpoint</strong>.</p>
</td>
</tr>
<tr id="drs_03_0104__row153462418456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p133505444511">inst_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p133501144459">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p173501543455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p1350846456">DB instance ID. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance. In DR scenarios, if <strong id="drs_03_0104__b142341381617">job_direction</strong> is set to <strong id="drs_03_0104__b102411317161">down</strong>, this parameter is mandatory in <strong id="drs_03_0104__b14717729171115">source_endpoint</strong>. If <strong id="drs_03_0104__b32431311612">job_direction</strong> is set to <strong id="drs_03_0104__b1024171318166">up</strong>, this parameter is mandatory in <strong id="drs_03_0104__b457593615113">target_endpoint</strong>.</p>
</td>
</tr>
<tr id="drs_03_0104__row163460415455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p635084184510">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p15350204144518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p43513411456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p335117416458">ID of the VPC where the database is located.</p>
</td>
</tr>
<tr id="drs_03_0104__row2346448453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p83515416458">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p19351745451">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p1435120434516">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p1335120474516">ID of the subnet where the database is located.</p>
</td>
</tr>
<tr id="drs_03_0104__row33463416453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p935204124517">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p1435216434517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p3352154144517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p6352149454">ID of the security group to which the database belongs.</p>
</td>
</tr>
<tr id="drs_03_0104__row2034614414456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p16352449457">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p63526424516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p17352104114510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p203537413451">The project ID of an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0104__row143461416455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p2353144114517">db_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p23547494519">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p035413414511">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p43541549459">Database password.</p>
</td>
</tr>
<tr id="drs_03_0104__row12346144194519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p14354844454">db_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p635415454516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p43549444511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p73544412451">Database port. The value is an integer ranging from 1 to 65535.</p>
</td>
</tr>
<tr id="drs_03_0104__row93463420458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p10355749455">db_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p33554454517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p53557414455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p135514415454">Database user.</p>
</td>
</tr>
<tr id="drs_03_0104__row43467494514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p43551845453">inst_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p935512418453">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p935617418452">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p376617414512">The name of an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0104__row63461442451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p17766174114511">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p11766194154513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p476619412458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p5766349452">Database IP address.</p>
</td>
</tr>
<tr id="drs_03_0104__row9346742452"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p137662494519">mongo_ha_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p576617413458">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p57662410451">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p107661640459">MongoDB HA mode.</p>
</td>
</tr>
<tr id="drs_03_0104__row0346143450"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p1176710413457">ssl_cert_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p10767144204516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p11767641451">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p19767641454">SSL certificate password. The certificate file name extension is .p12.</p>
</td>
</tr>
<tr id="drs_03_0104__row63468412452"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p117674416452">ssl_cert_check_sum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p1476719410459">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p1776784114510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p1576713410451">The checksum value of the SSL certificate, which is used for backend verification. This parameter is mandatory for secure connection to the source database.</p>
</td>
</tr>
<tr id="drs_03_0104__row834612414515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p1176774154511">ssl_cert_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p37671541457">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p1276717414456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p376719404515">SSL certificate content, which is encrypted using Base64.</p>
</td>
</tr>
<tr id="drs_03_0104__row834664184514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p976720413455">ssl_cert_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p976764164518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p117670417458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p127671845458">SSL certificate name.</p>
</td>
</tr>
<tr id="drs_03_0104__row234618444512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p187675464512">ssl_link</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p47672412457">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p16767147455">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p1276754174512">Whether SSL is enabled.</p>
</td>
</tr>
<tr id="drs_03_0104__row178323505612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="drs_03_0104__p28334501169">cluster_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="drs_03_0104__p148335509615">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="drs_03_0104__p128331150262">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="drs_03_0104__p883313506613">For MongoDB 4.0 or later, if the cluster instance cannot obtain the IP address of the sharded node, set <strong id="drs_03_0104__b78292371520">source_endpoint</strong> to <strong id="drs_03_0104__b1351522761515">Sharding4.0+</strong>.</p>
<p id="drs_03_0104__p13318182018916">Default value: <strong id="drs_03_0104__b88041318111612">Sharding4.0+</strong></p>
<p id="drs_03_0104__p15318182016915">Values:</p>
<ul id="drs_03_0104__ul1631814204917"><li id="drs_03_0104__li93184201896"><strong id="drs_03_0104__b1531882017918">Sharding4.0+</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0104__request_ResourceTag"></a><a name="request_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__request_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResourceTag</caption><thead align="left"><tr id="drs_03_0104__row1936215474514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="drs_03_0104__p576812434516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="drs_03_0104__p67681474515">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="drs_03_0104__p177685464519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="drs_03_0104__p1476815410455">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row1436274124510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="drs_03_0104__p176814164514">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="drs_03_0104__p17768134114513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="drs_03_0104__p67681441455">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="drs_03_0104__p176818410458">Tag key. The value can contain a maximum of 36 characters, including letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="drs_03_0104__row15362543453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="drs_03_0104__p1776813464520">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="drs_03_0104__p18768248454">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="drs_03_0104__p137681842454">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="drs_03_0104__p87684444518">Tag value. The value can contain a maximum of 43 characters, including letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0104__section13768194124510"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0104__p4768164114512"><strong id="drs_03_0104__b18167080481">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0104__row6364346455"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="drs_03_0104__p17686412451">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="drs_03_0104__p9768194104519">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="drs_03_0104__p1176811484518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row0364114114516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="drs_03_0104__p167681243452">results</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="drs_03_0104__p1976815413458">Array of <a href="#drs_03_0104__response_CreateJobResp">CreateJobResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="drs_03_0104__p10768547454">The response body for creating tasks in batches.</p>
</td>
</tr>
<tr id="drs_03_0104__row173643414517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="drs_03_0104__p1076818484514">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="drs_03_0104__p07684415454">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="drs_03_0104__p3768643451">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0104__response_CreateJobResp"></a><a name="response_CreateJobResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__response_CreateJobResp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>CreateJobResp</caption><thead align="left"><tr id="drs_03_0104__row153669416458"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="drs_03_0104__p157685484515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="drs_03_0104__p1476812418455">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="drs_03_0104__p177681442457">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row13366154194516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p207691149452">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p1376919416458">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p07692419451">Task ID.</p>
</td>
</tr>
<tr id="drs_03_0104__row97031443397"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p970374123910">child_ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p47031453920">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p1670394203917">Subtask ID set. This parameter is returned when there are subtasks.</p>
</td>
</tr>
<tr id="drs_03_0104__row2366124164514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p67692041453">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p67699444518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p1876913494519">Task name.</p>
</td>
</tr>
<tr id="drs_03_0104__row8366134134518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p276994184519">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p976920411455">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p1276994104518">Task status.</p>
</td>
</tr>
<tr id="drs_03_0104__row1336616413451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p276913474512">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p1476916484511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p18769449456">Creation time (timestamp).</p>
</td>
</tr>
<tr id="drs_03_0104__row436674204513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p076918414458">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p87692042453">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p97692416459">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0104__row636613474518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_03_0104__p1769949454">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_03_0104__p276904114514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_03_0104__p27694454511">Error message, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0104__section5349111218142"><h4 class="sectiontitle">Example Request</h4><ul id="drs_03_0104__ul6349141281420"><li id="drs_03_0104__li4349812171413">Example for creating real-time MySQL migration tasks in batches.<pre class="screen" id="drs_03_0104__screen1356817339218">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation</pre>
<pre class="screen" id="drs_03_0104__screen122617334218">{
"jobs" : [ {
"name" : "DRS-9228",
"node_type" : "high",
"engine_type" : "mysql",
"net_type" : "eip",
"job_direction" : "up",
"db_use_type" : "migration",
"task_type" : "FULL_INCR_TRANS",
"customize_sutnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
"source_endpoint" : {
"db_type" : "mysql"
},
"target_endpoint" : {
"region" : "eu-de",
"db_type" : "mysql",
"inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01"
},
"is_target_readonly" : false,
"bind_eip" : true
} ]
}</pre>
</li><li id="drs_03_0104__li183501612131410">Example for creating real-time MySQL DR tasks (Current cloud as standby).<pre class="screen" id="drs_03_0104__screen4350121212144">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation</pre>
<pre class="screen" id="drs_03_0104__screen41633222025">{
"jobs" : [ {
"name" : "DRS-api-test",
"engine_type" : "cloudDataGuard-mysql",
"net_type" : "eip",
"node_type" : "high",
"job_direction" : "up",
"source_endpoint" : {
"db_type" : "mysql"
},
"target_endpoint" : {
"region" : "eu-de",
"db_type" : "mysql",
"inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0"
},
"is_target_readonly" : true,
"bind_eip" : true,
"db_use_type" : "cloudDataGuard",
"task_type" : "FULL_INCR_TRANS",
"customize_sutnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
"multi_write" : false
} ]
}</pre>
</li><li id="drs_03_0104__li143511012141410">Example for creating real-time migration tasks for DDS replica set instances.<pre class="screen" id="drs_03_0104__screen18351151218148">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation</pre>
<pre class="screen" id="drs_03_0104__screen5483162813599">{
"jobs" : [ {
"name" : "DRS-3371-linxiaolu",
"node_type" : "high",
"engine_type" : "mongodb",
"net_type" : "eip",
"job_direction" : "up",
"db_use_type" : "migration",
"task_type" : "FULL_INCR_TRANS",
"customize_sutnet_id" : "faf513f3-7a88-4a5c-bec7-238699c29c17",
"source_endpoint" : {
"db_type" : "mongodb"
},
"target_endpoint" : {
"region" : "eu-de",
"db_type" : "mongodb",
"inst_id" : "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02"
},
"bind_eip" : true
} ]
}</pre>
</li><li id="drs_03_0104__li19352112161410">Example for creating a MySQL primary/standby task.<pre class="screen" id="drs_03_0104__screen4352712201411">https://192.107.54.184:10011/drs/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-creation</pre>
<pre class="screen" id="drs_03_0104__screen2479161615911">{
"jobs" : [ {
"name" : "DRS-linxiaolu-test3",
"engine_type" : "mysql",
"net_type" : "eip",
"node_type" : "high",
"job_direction" : "up",
"source_endpoint" : {
"db_type" : "mysql"
},
"target_endpoint" : {
"region" : "eu-de",
"db_type" : "mysql",
"inst_id" : "64e8d7a31afa476ca85609a17af83765in01",
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0"
},
"bind_eip" : true,
"db_use_type" : "sync",
"task_type" : "FULL_INCR_TRANS",
"customize_sutnet_id" : "0cf77cfb-3785-4065-a9c4-74b7bb2df071",
"master_az" : "az2xahz",
"slave_az" : "az3xahz"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="drs_03_0104__section27721244455"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0104__p13772645456"><strong id="drs_03_0104__b18794341102016">Status code: 202</strong></p>
<p id="drs_03_0104__p677215444512">Accepted</p>
<pre class="screen" id="drs_03_0104__screen1577211414510">{
"results" : [ {
"id" : "e11eaf8f-71ef-4fad-8890-aed7572ajb11",
"name" : "DRS-9228",
"status" : "CREATING",
"create_time" : "1599188556112"
} ],
"count" : 1
}</pre>
</div>
<div class="section" id="drs_03_0104__section157729464518"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0104__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0104__row1037934154515"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="drs_03_0104__p117721649450">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="drs_03_0104__p187729420458">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0104__row1379942450"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="drs_03_0104__p1677264164519">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="drs_03_0104__p17264237191318">Accepted</p>
</td>
</tr>
<tr id="drs_03_0104__row93791942453"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="drs_03_0104__p47729410456">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="drs_03_0104__p157726404518">Bad Request</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0104__section16772449454"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0104__p117723404515">For details, see <a href="drs_05_0004.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="drs_03_0101.html">Public API Management</a></div>
</div>
</div>
View Git Blame Copy Permalink