forked from docs/doc-exports
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>
817 lines
60 KiB
HTML
817 lines
60 KiB
HTML
<a name="drs_03_0107"></a><a name="drs_03_0107"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Tasks in Batches</h1>
|
|
<div id="body19385027133911"><div class="section" id="drs_03_0107__section17385172717395"><h4 class="sectiontitle">Function</h4><p id="drs_03_0107__p3385122763913">This API is used to modify task names or descriptions in batches and set exception notification.</p>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section20901627163916"><h4 class="sectiontitle">Constraints</h4><ul id="drs_03_0107__ul1582633623213"><li id="drs_03_0107__li482683673211">After the test of connections to the source and destination databases is successful, you need to call this API. Enter the source and destination database information according to the example. Otherwise, errors may occur in subsequent tasks.</li><li id="drs_03_0107__li26821239153219">This API can be invoked when the task name, description, or exception notification is modified but the task is not in the stopped or deleted state.</li><li id="drs_03_0107__li19629425183310">This API is invoked after connections to the source and destination databases are tested. The task must be in <strong id="drs_03_0107__b09638195141">CONFIGURATION</strong> state. In the dual-active DR scenario, the parent task cannot call the API.</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section43869278398"><h4 class="sectiontitle">URI</h4><p id="drs_03_0107__p1638616276394">PUT /v3/{project_id}/jobs/batch-modification</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__table163881927173919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0107__row73870271393"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0107__p1438992723912">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_0107__p103892027123919">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_0107__p18389027153917">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_0107__p123901527103910">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row538832715396"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0107__p1139013277398">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0107__p1039112710391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0107__p143911227123911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0107__p3391162719393">Project ID of a tenant in a region</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section9391102773910"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0107__row03926272396"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_03_0107__p133921727123917">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="drs_03_0107__p8393182783915">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="drs_03_0107__p739332716391">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="drs_03_0107__p11393142703913">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row7392227103912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0107__p17393142715393">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0107__p639418278396">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0107__p1939413274395">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0107__p1449718306424">The content type.</p>
|
|
<p id="drs_03_0107__p123256415450">The default value is <strong id="drs_03_0107__b0565113344220">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row33928270394"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0107__p14394152711395">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0107__p1394132793913">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0107__p539472715394">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0107__p339522713390">User token obtained from IAM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row639213274399"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0107__p539512717396">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0107__p639512703911">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0107__p12395102773918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0107__p1939562713399">Request language type</p>
|
|
<p id="drs_03_0107__p68691956125917">Default value: <strong id="drs_03_0107__b1786912566599">en-us</strong></p>
|
|
<p id="drs_03_0107__p1386915625912">Values:</p>
|
|
<ul id="drs_03_0107__ul1586965613591"><li id="drs_03_0107__li1886915655910"><strong id="drs_03_0107__b158691656145912">en-us</strong></li><li id="drs_03_0107__li17869125685916"><strong id="drs_03_0107__b12869175615914">zh-cn</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0107__row12396027173916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_03_0107__p13397162743911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="drs_03_0107__p9397027183912">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="drs_03_0107__p163971327143910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="drs_03_0107__p339792763911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row439622713392"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0107__p1039762723914">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0107__p8397142743913">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0107__p1939812703911">Array of <a href="#drs_03_0107__request_ModifyJobReq">ModifyJobReq</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0107__p163987274396">Request body for modifying tasks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__request_ModifyJobReq"></a><a name="request_ModifyJobReq"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__request_ModifyJobReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ModifyJobReq</caption><thead align="left"><tr id="drs_03_0107__row103981927183912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="drs_03_0107__p14399102710398">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="drs_03_0107__p1439913278393">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.4.4.2.5.1.3"><p id="drs_03_0107__p1239962783919">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.03%" id="mcps1.3.4.4.2.5.1.4"><p id="drs_03_0107__p14400182720394">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row15398127133920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p174007279396">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p04006270391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p1040092793916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p440012272393">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row14398142711392"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p12400112717395">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p34018274397">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p44014274393">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p14018278396">Task description. This parameter is mandatory when you modify the task description.</p>
|
|
<p id="drs_03_0107__p5401127163918">Minimum length: 0 character</p>
|
|
<p id="drs_03_0107__p1240111278395">Maximum length: <strong id="drs_03_0107__b640142717393">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1639822710391"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p204021927203910">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p040213271396">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p4402727203919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p164021327143913">Task name. Set this parameter when you need to change the task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row7398142763913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p20402027163917">alarm_notify</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p13402132718394">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p104031827133919"><a href="#drs_03_0107__request_AlarmNotifyInfo">AlarmNotifyInfo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p19403027113916">Set exception notification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row9293198182310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p32946822316">task_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p18294986233">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p172941281237">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p147851736154314">Task mode. Values:</p>
|
|
<ul id="drs_03_0107__ul1623943211184"><li id="drs_03_0107__li7239183251811"><strong id="drs_03_0107__b10582134865317">FULL_TRANS</strong>: full migration</li><li id="drs_03_0107__li192391932121811"><strong id="drs_03_0107__b1266431142218">INCR_TRANS</strong>: incremental migration</li><li id="drs_03_0107__li11239143221812"><strong id="drs_03_0107__b14628183162212">FULL_INCR_TRANS</strong>: full+incremental migration</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1493245072917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p1293217508291">source_endpoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p19932125092919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p09321501291"><a href="#drs_03_0107__request_Endpoint">Endpoint</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p09325506296">Source database information. This parameter is mandatory for calling the API after the connection test.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row94171717347"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p44176733410">target_endpoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p14171077348">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p5257740203411"><a href="#drs_03_0107__request_Endpoint">Endpoint</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p1625714073416">Destination database information. This parameter is mandatory for calling the API after the connection test.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row66493445589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p1265044485817">node_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p565044412584">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p965014405815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p07048179440">Node specification type. This parameter is mandatory when this API is invoked to modify a task after the connection test.</p>
|
|
<p id="drs_03_0107__p15241133211185">Default value: <strong id="drs_03_0107__b1533811401712">high</strong></p>
|
|
<p id="drs_03_0107__p4241203241814">Values:</p>
|
|
<ul id="drs_03_0107__ul1024117323187"><li id="drs_03_0107__li14241143251812"><strong id="drs_03_0107__b22411032171819">high</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row171521048125813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p111521848165815">engine_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p111529485589">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p715311484584">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p10701940193317">Engine type of a DRS task. This parameter is mandatory when this API is invoked to modify a task after the connection test.</p>
|
|
<p id="drs_03_0107__p14242123241810">Values:</p>
|
|
<ul id="drs_03_0107__ul1186120014335"><li id="drs_03_0107__li3861120113310"><strong id="drs_03_0107__b37101101827">mysql</strong>: used for migration and synchronization from MySQL to MySQL</li><li id="drs_03_0107__li6862904336"><strong id="drs_03_0107__b566216141212">mongodb</strong>: used for migration from MongoDB to DDS</li><li id="drs_03_0107__li986250133312"><strong id="drs_03_0107__b46051016624">cloudDataGuard-mysql</strong>: used for DR from MySQL to MySQL</li><li id="drs_03_0107__li1386260193311"><strong id="drs_03_0107__b15473427327">mysql-to-taurus</strong>: used for synchronization from MySQL to GaussDB(for MySQL) primary/standby</li><li id="drs_03_0107__li0352957122719"><strong id="drs_03_0107__b0148124914217">postgresql</strong>: used for synchronization from PostgreSQL to PostgreSQL</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1579295813581"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p18792058105818">net_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p117921581589">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p14792155816583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p1833854104517">Network type. This parameter is mandatory after the connection test. Values:</p>
|
|
<ul id="drs_03_0107__ul13381343458"><li id="drs_03_0107__li153381414514"><strong id="drs_03_0107__b1933819411450">vpn</strong></li><li id="drs_03_0107__li9338154124515"><strong id="drs_03_0107__b153396474519">vpc</strong></li><li id="drs_03_0107__li83391414519"><strong id="drs_03_0107__b153392046451">eip</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row19577520592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p175773218597">store_db_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p1957742175912">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p1057712275920">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p71251121201118">Whether to save the database information. This parameter is mandatory when the API is called after the connection test.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1539310645916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p19393146135914">is_recreate</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p18393106115919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p539316611597">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p103211343101118">Whether the task is a rebuilding task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row140111101592"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p1640117100597">job_direction</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p15401310125916">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p84017108597">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p296873019405">Task direction.</p>
|
|
<p id="drs_03_0107__p10520192315421">Values:</p>
|
|
<ul id="drs_03_0107__ul19521202324211"><li id="drs_03_0107__li13521112313422"><strong id="drs_03_0107__b86861641847">up</strong>: to-the-cloud scenarios and the current cloud is the standby cloud in the DR.</li><li id="drs_03_0107__li11521112310428"><strong id="drs_03_0107__b20595988419">down</strong>: out-of-cloud scenarios and the current cloud is the active cloud in the DR.</li><li id="drs_03_0107__li4521723184219"><strong id="drs_03_0107__b1969611107416">non-dbs</strong>: self-built databases.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row19461913205920"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p2946141385917">is_target_readonly</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p11946191315918">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p14946181310598">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p49582331218">Whether the destination DB instance can be read-only.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row168811517105919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p8881117135912">replace_definer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p17881817105912">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p9881171717593">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p13415207128">Whether to migrate all Definers to the user. MySQL databases support this setting. This parameter is mandatory when this API is invoked to modify a task after the connection test. Values:</p>
|
|
<ul id="drs_03_0107__ul181674567518"><li id="drs_03_0107__li1116713569514"><strong id="drs_03_0107__b20238152181813">true</strong>: The Definers of all source database objects will be migrated to the user. Other users do not have permissions on database objects unless they are authorized.</li><li id="drs_03_0107__li111311941161"><strong id="drs_03_0107__b15739120141919">false</strong>: The Definers of all source database objects will not be changed. You need to migrate all accounts and permissions of the source database in the next step.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row134335533594"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p1043316534591">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p144331553105910">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p934204164518">Array of <a href="#drs_03_0107__request_ResourceTag">ResourceTag</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p1534313494515">Specifies the tag information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row47281237517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0107__p6728152320517">db_use_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0107__p137289234516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0107__p972852312511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0107__p156891436124511">Migration type.</p>
|
|
<p id="drs_03_0107__p5250432171810">Values:</p>
|
|
<ul id="drs_03_0107__ul14250113251816"><li id="drs_03_0107__li4250432151816"><strong id="drs_03_0107__b81852217417">migration</strong>: real-time migration.</li><li id="drs_03_0107__li112516321186"><strong id="drs_03_0107__b14283724348">sync</strong>: real-time synchronization.</li><li id="drs_03_0107__li13251113212181"><strong id="drs_03_0107__b9163133517">cloudDataGuard</strong>: real-time disaster recovery.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__request_AlarmNotifyInfo"></a><a name="request_AlarmNotifyInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__request_AlarmNotifyInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>AlarmNotifyInfo</caption><thead align="left"><tr id="drs_03_0107__row1740392763920"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="drs_03_0107__p134041227133917">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="drs_03_0107__p840482713920">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="drs_03_0107__p1440532783918">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="drs_03_0107__p204058277392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row3403182743917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0107__p84051027173916">delay_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0107__p7405172793913">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0107__p1440572743914">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0107__p24051127193910">Subscription delay, in seconds.</p>
|
|
<ul id="drs_03_0107__ul81241634121010"><li id="drs_03_0107__li17124934141010">Minimum value: <strong id="drs_03_0107__b7406142743915">1</strong></li><li id="drs_03_0107__li1012403461017">Maximum value: <strong id="drs_03_0107__b1866183951919">3600</strong></li><li id="drs_03_0107__li812423451013">Default value: <strong id="drs_03_0107__b840612712395">0</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row74032027113919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0107__p184061227183912">rto_delay</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0107__p10406182713394">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0107__p940615272392">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0107__p164069275392">Recovery Time Objective (RTO) delay, in seconds.</p>
|
|
<ul id="drs_03_0107__ul1272754261011"><li id="drs_03_0107__li12727184221015">Minimum value: <strong id="drs_03_0107__b140702753918">1</strong></li><li id="drs_03_0107__li972704211017">Maximum value: <strong id="drs_03_0107__b95111202208">3600</strong></li><li id="drs_03_0107__li1972754291012">Default value: <strong id="drs_03_0107__b184071127173913">0</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row20403142714394"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0107__p3407627173918">rpo_delay</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0107__p14077279390">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0107__p134081527153914">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0107__p154081327203920">Recovery Point Objective (RPO) delay, in seconds.</p>
|
|
<ul id="drs_03_0107__ul15791813171110"><li id="drs_03_0107__li185791413131114">Minimum value: <strong id="drs_03_0107__b740813277395">1</strong></li><li id="drs_03_0107__li1757910133116">Maximum value: <strong id="drs_03_0107__b186556642014">3600</strong></li><li id="drs_03_0107__li105791913191112">Default value: <strong id="drs_03_0107__b04081327103914">0</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row740312710391"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0107__p34081827193913">alarm_to_user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0107__p840822733914">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0107__p440914270398">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0107__p2409192715394">Whether to notify users of alarms. The default value is <strong id="drs_03_0107__b13953153111203">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row54031127143912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0107__p1340918271398">subscriptions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0107__p164091627133917">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0107__p14091627163918">Array of <a href="#drs_03_0107__request_SubscriptionInfo">SubscriptionInfo</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0107__p1410162763914">Receiving method and message body. Up to two receiving modes and message bodies are supported.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__request_SubscriptionInfo"></a><a name="request_SubscriptionInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__request_SubscriptionInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>SubscriptionInfo</caption><thead align="left"><tr id="drs_03_0107__row5410202713914"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="drs_03_0107__p174111927183919">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.2"><p id="drs_03_0107__p54111427163914">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.3"><p id="drs_03_0107__p164111527103918">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.6.2.5.1.4"><p id="drs_03_0107__p8411127183912">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row2410142773918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_03_0107__p164111527113913">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_03_0107__p12412427103916">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_03_0107__p541202763916">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="drs_03_0107__p9412152712393">List of mobile numbers or email addresses. Use commas (,) to separate multiple mobile numbers or email addresses. Up to 10 mobile numbers or email addresses are supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1641012279391"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_03_0107__p134121727123919">protocol</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_03_0107__p44131727193920">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_03_0107__p841372718393">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="drs_03_0107__p241362773913">Receiving method. Values:</p>
|
|
<ul id="drs_03_0107__ul4413142711394"><li id="drs_03_0107__li3413182716394"><strong id="drs_03_0107__b1365390008466">sms</strong>: SMS message</li><li id="drs_03_0107__li12413827113917"><strong id="drs_03_0107__b3265125132113">email</strong>: email.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__request_Endpoint"></a><a name="request_Endpoint"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__request_Endpoint" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Endpoint</caption><thead align="left"><tr id="drs_03_0107__row4277743451"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.1"><p id="drs_03_0107__p227684319514"><strong id="drs_03_0107__b1071804804014">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.2"><p id="drs_03_0107__p22768432057">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.3"><p id="drs_03_0107__p1527612431351">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.7.2.5.1.4"><p id="drs_03_0107__p1927614319512"><strong id="drs_03_0107__b1859885424014">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row4379943654"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p63779431759">db_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p537704317513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p1437717431850">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p15377643452">Database type. This parameter is mandatory when this API is invoked to modify a task after the connection test. Values:</p>
|
|
<ul id="drs_03_0107__ul437854311512"><li id="drs_03_0107__li103771431151"><strong id="drs_03_0107__b173771343550">mysql</strong></li><li id="drs_03_0107__li23781643358"><strong id="drs_03_0107__b1037818439517">mongodb</strong></li><li id="drs_03_0107__li113789431652"><strong id="drs_03_0107__b11378643754">taurus</strong></li></ul>
|
|
<ul id="drs_03_0107__ul1437984313510"><li id="drs_03_0107__li1337913431653"><strong id="drs_03_0107__b173781843652">postgresql</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row12379943554"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p113791443257">az_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p937954312510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p133799431758">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p14379643458">Code of the AZ where the database is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row123801435510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p4379134312514">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p183798431950">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p16379843251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p9380114313517">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_0107__b14428911913">job_direction</strong> is set to <strong id="drs_03_0107__b1117112892">down</strong>, this parameter is mandatory in <strong id="drs_03_0107__b1863611151098">source_endpoint</strong>. If <strong id="drs_03_0107__b42601218094">job_direction</strong> is set to <strong id="drs_03_0107__b15571524399">up</strong>, this parameter is mandatory in <strong id="drs_03_0107__b16943848898">target_endpoint</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row173809432510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p438019431518">inst_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p1238014437510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p183801443759">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1338014318515">ID of the DB instance. 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_0107__b1994325811912">job_direction</strong> is set to <strong id="drs_03_0107__b9943125810914">down</strong>, this parameter is mandatory in <strong id="drs_03_0107__b1394385812920">source_endpoint</strong>. If <strong id="drs_03_0107__b894412581395">job_direction</strong> is set to <strong id="drs_03_0107__b1394412581295">up</strong>, this parameter is mandatory in <strong id="drs_03_0107__b994417581495">target_endpoint</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row133819437511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1138024313516">vpc_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p138011437516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p183803431756">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p638112431355">ID of the VPC where the database is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row6381124310514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p43813431757">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p1381184320510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p13381743452">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p83811443254">ID of the subnet where the database is located.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row193821439513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p14381144317511">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p1838110431512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p6381154312511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p238212431754">ID of the security group to which the database belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1538318431551"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1938212433511">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p53821943655">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p83824431511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1138312437516">The project ID of an RDS or GaussDB(for MySQL) instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row338454317519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1838312433518">db_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p83832436513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p9383124314517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p33831431658">Database password.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1338464312510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p0384343651">db_port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p33844432518">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p638416432511">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1238416431858">Database port. The value is an integer ranging from 1 to 65535.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1638544317510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p238424311517">db_user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p538417438520">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p938424318518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p17384104317517">Database user.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row5385443651"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p5385164314518">inst_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p8385443552">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p16385134317517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p73857431511">The name of an RDS or GaussDB(for MySQL) instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row63862043251"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p163855431551">ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p11385164319514">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p15385043551">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1538512431554">Database IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row938744317512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1638620435510">mongo_ha_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p163861443952">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p123864431512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p13387114316518">MongoDB HA mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row14389164318511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p63893434515">ssl_cert_password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p238914436517">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p10389743358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1938916434510">SSL certificate password. The certificate file name extension is .p12.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row639016431854"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p103891943459">ssl_cert_check_sum</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p5389184319515">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p23891043957">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p938915431054">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_0107__row1539013431755"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1639014431651">ssl_cert_key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p163901043957">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p1339017431512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p339012437514">SSL certificate content, which is encrypted using Base64.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row93902431158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1239019434515">ssl_cert_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p3390184313516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p53901043058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p173902432513">SSL certificate name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row19391154314517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p1239014312511">ssl_link</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p123901443852">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p123907432516">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p73917437517">Whether SSL is enabled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1039216431354"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0107__p5391343350">cluster_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0107__p153914431650">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0107__p73918431154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0107__p1139113431550">For MongoDB 4.0 or later, if the cluster instance cannot obtain the IP address of the sharded node, set <strong id="drs_03_0107__b14115205413586">cluster_mode</strong> in <strong id="drs_03_0107__b134211240155620">source_endpoint</strong> to <strong id="drs_03_0107__b16427174014561">Sharding4.0+</strong>.</p>
|
|
<p id="drs_03_0107__p183918431152">Default value: <strong id="drs_03_0107__b174517235911">Sharding4.0+</strong></p>
|
|
<p id="drs_03_0107__p73921843751">Values:</p>
|
|
<ul id="drs_03_0107__ul539219432511"><li id="drs_03_0107__li15392114313516"><strong id="drs_03_0107__b133927431453">Sharding4.0+</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__request_ResourceTag"></a><a name="request_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__request_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ResourceTag</caption><thead align="left"><tr id="drs_03_0107__row042514332056"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.1"><p id="drs_03_0107__p94249332056"><strong id="drs_03_0107__b10267182714594">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.2"><p id="drs_03_0107__p64251338514">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.5.1.3"><p id="drs_03_0107__p3425633659">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.8.2.5.1.4"><p id="drs_03_0107__p04251233459"><strong id="drs_03_0107__b447113255914">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row19542133858"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="drs_03_0107__p7541333253">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="drs_03_0107__p154110337513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="drs_03_0107__p454110337518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="drs_03_0107__p154113319515">Tag key. The value can contain a maximum of 36 characters, including letters, digits, underscores (_), and hyphens (-). Set this parameter when you need to modify a tag.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1154353319515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.1 "><p id="drs_03_0107__p15421433852">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.2 "><p id="drs_03_0107__p1154215331153">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.5.1.3 "><p id="drs_03_0107__p165423339518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.8.2.5.1.4 "><p id="drs_03_0107__p7543033852">Tag value. The value can contain a maximum of 43 characters, including letters, digits, underscores (_), and hyphens (-). Set this parameter when you need to modify a tag.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section124141275390"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0107__p194141327203915"><strong id="drs_03_0107__b641418278395">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0107__row5414182733918"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_03_0107__p1241511278395">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="drs_03_0107__p9415142719391">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="drs_03_0107__p1141552719390">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row204141727123917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0107__p8416122743912">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0107__p194161127193911">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0107__p4417202710394">Total number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row54141627163916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0107__p16417122753910">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0107__p54174277391">Array of <a href="#drs_03_0107__response_ModifyJobResp">ModifyJobResp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0107__p1341818276398">List of tasks that are modified in batches.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0107__response_ModifyJobResp"></a><a name="response_ModifyJobResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__response_ModifyJobResp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>ModifyJobResp</caption><thead align="left"><tr id="drs_03_0107__row134186276398"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_03_0107__p10419202715399">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="drs_03_0107__p1441919277397">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="drs_03_0107__p1541932783916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row104182273397"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0107__p1042017270391">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0107__p44201027123916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0107__p134209276397">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1841802763911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0107__p13420122720391">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0107__p17420727183917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0107__p6421122719394">Status Values:</p>
|
|
<ul id="drs_03_0107__ul64211227173915"><li id="drs_03_0107__li542152719392"><strong id="drs_03_0107__b91419338133">success</strong>: The task is successful.</li><li id="drs_03_0107__li44211027183920"><strong id="drs_03_0107__b72621735121314">failed</strong>: The task fails.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row3418112711397"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0107__p442162703915">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0107__p342162720394">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0107__p10422527153919">Error code, which is optional and indicates the returned information about the failure status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row441832713919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0107__p19422162723910">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0107__p3422827153911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0107__p9422132720399">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_0107__section1342332711393"><h4 class="sectiontitle">Example Request</h4><ul id="drs_03_0107__ul642322719395"><li id="drs_03_0107__li742382711397">Example of changing task names in batches:<pre class="screen" id="drs_03_0107__screen914420110143">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification</pre>
|
|
<pre class="screen" id="drs_03_0107__screen227976181416">{
|
|
"jobs" : [ {
|
|
"job_id" : "140b5236-88ad-43c8-811c-1268453jb101",
|
|
"name" : "testName"
|
|
} ]
|
|
}</pre>
|
|
</li><li id="drs_03_0107__li124261427143918">Request for setting task exception notifications in batches:<pre class="screen" id="drs_03_0107__screen1113062519145">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification</pre>
|
|
<pre class="screen" id="drs_03_0107__screen13119345148">{
|
|
"jobs" : [ {
|
|
"job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
|
|
"alarm_notify" : {
|
|
"delay_time" : 0,
|
|
"rto_delay" : 0,
|
|
"rpo_delay" : 0,
|
|
"alarm_to_user" : false,
|
|
"subscriptions" : [ {
|
|
"protocol" : "sms",
|
|
"endpoints" : [ "150xxxxxxxx" ]
|
|
}, {
|
|
"protocol" : "email",
|
|
"endpoints" : [ "abc@xxx.com" ]
|
|
} ]
|
|
}
|
|
} ]
|
|
}</pre>
|
|
</li><li id="drs_03_0107__li11429127133913">Example of modifying task description in batches:<pre class="screen" id="drs_03_0107__screen1738995231412">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification</pre>
|
|
<pre class="screen" id="drs_03_0107__screen11111608157">{
|
|
"jobs" : [ {
|
|
"job_id" : "140b5236-88ad-43c8-811c-1268453jb101",
|
|
"name" : "testName",
|
|
"description" : "test description"
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="drs_03_0107__ul1286144614173"><li id="drs_03_0107__li7345258191719">Example of calling the API after the MySQL connection test:<pre class="screen" id="drs_03_0107__screen546282021510">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification</pre>
|
|
<pre class="screen" id="drs_03_0107__screen184751853121516">{
|
|
"jobs": [{
|
|
"job_id": "1fded2ab-ce99-4b0e-9cc9-9ce7e17jb101",
|
|
"name": "DRS-5646-linxiaolu",
|
|
"source_endpoint": {
|
|
"region": "eu-de",
|
|
"ip": "192.168.0.27",
|
|
"db_port": "3306",
|
|
"db_user": "root",
|
|
"db_password": "<strong id="drs_03_0107__en-us_topic_0117388899_b11681345144418"><em id="drs_03_0107__en-us_topic_0117388899_i126812457441">********</em></strong>",
|
|
"ssl_link": false,
|
|
"db_type": "mysql",
|
|
"project_id": "054ba152d480d55b2f5dc0069e7ddef0"
|
|
},
|
|
"target_endpoint": {
|
|
"region": "eu-de",
|
|
"db_type": "mysql",
|
|
"db_user": "root",
|
|
"db_password": "<strong id="drs_03_0107__b6736416132619"><em id="drs_03_0107__i3736141652614">********</em></strong>",
|
|
"project_id": "054ba152d480d55b2f5dc0069e7ddef0",
|
|
"inst_id": "3def1ac7f8ab4ae48d7c025339f80414in01"
|
|
},
|
|
"node_type": "high",
|
|
"engine_type": "mysql",
|
|
"store_db_info": true,
|
|
"net_type": "eip",
|
|
"replace_definer": true
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="drs_03_0107__ul19533012266"><li id="drs_03_0107__li1795530122619">Example of calling the API after the MongoDB connection test:<pre class="screen" id="drs_03_0107__screen271802213166">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-modification</pre>
|
|
<pre class="screen" id="drs_03_0107__screen32251138151618">{
|
|
"jobs": [{
|
|
"job_id": "741d91cf-67e8-4126-ad0f-32f6cccjb105",
|
|
"name": "DRS-4513",
|
|
"source_endpoint": {
|
|
"region": "eu-de",
|
|
"ip": "192.168.11.231:8635,192.168.10.12:8635",
|
|
"db_port": 0,
|
|
"db_user": "rwuser",
|
|
"db_password": "<strong id="drs_03_0107__b12570526102611"><em id="drs_03_0107__i0570326132619">********</em></strong>",
|
|
"ssl_link": false,
|
|
"db_type": "mongodb",
|
|
"project_id": "0549a6a31000d4e82fd1c00c3d6f2d76",
|
|
"db_name": "admin"
|
|
},
|
|
"target_endpoint": {
|
|
"region": "eu-de",
|
|
"db_type": "mongodb",
|
|
"db_user": "rwuser",
|
|
"db_password": "<strong id="drs_03_0107__b11821532122616"><em id="drs_03_0107__i14821193262615">********</em></strong>",
|
|
"project_id": "0549a6a31000d4e82fd1c00c3d6f2d76",
|
|
"inst_id": "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02"
|
|
},
|
|
"node_type": "high",
|
|
"engine_type": "mongodb",
|
|
"net_type": "eip",
|
|
"store_db_info": true
|
|
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="drs_03_0107__section18430127163919"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0107__p4431202714391"><strong id="drs_03_0107__b174311827113913">Status code: 200</strong></p>
|
|
<p id="drs_03_0107__p13431172783916">OK</p>
|
|
<pre class="screen" id="drs_03_0107__screen243182713396">{
|
|
"results" : [ {
|
|
"id" : "efa2bd29-8780-494f-a2ee-188b003ejb11",
|
|
"status" : "success"
|
|
} ],
|
|
"count" : 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section66894273398"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0107__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0107__row1143313277391"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.10.2.1.3.1.1"><p id="drs_03_0107__p669016278390">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.10.2.1.3.1.2"><p id="drs_03_0107__p56908272392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0107__row10433112703912"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.10.2.1.3.1.1 "><p id="drs_03_0107__p1469082715395">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.10.2.1.3.1.2 "><p id="drs_03_0107__p1369020276398">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0107__row1433827123913"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.10.2.1.3.1.1 "><p id="drs_03_0107__p146908277397">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.10.2.1.3.1.2 "><p id="drs_03_0107__p16690192783919">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0107__section11690227183918"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0107__p7690102793910">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>
|
|
|