lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/drs/api-ref/drs_api_0151.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

1074 lines
78 KiB
HTML
Raw Blame History

<a name="drs_api_0151"></a><a name="drs_api_0151"></a>
<h1 class="topictitle1">Querying Task Details in Batches</h1>
<div id="body12288101417511"><div class="section" id="drs_api_0151__section19288121485117"><h4 class="sectiontitle">Function</h4><p id="drs_api_0151__p16289151414510">This API is used to query task details in batches by task ID.</p>
</div>
<div class="section" id="drs_api_0151__section628911413517"><h4 class="sectiontitle">URI</h4><p id="drs_api_0151__p2289161475110">POST /v3/{project_id}/jobs/batch-detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__table7290214185120" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_api_0151__row1290121465117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="drs_api_0151__p629010145512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="drs_api_0151__p129021410516">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="drs_api_0151__p132912147513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="drs_api_0151__p6291111415117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row152901614115119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="drs_api_0151__p4291201415120">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="drs_api_0151__p10291141418515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="drs_api_0151__p329231416515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="drs_api_0151__p82923145513">Project ID of a tenant in a region</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_api_0151__section1129241495116"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_api_0151__row6292714105110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="drs_api_0151__p3293141419512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="drs_api_0151__p129341415111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="drs_api_0151__p192941514115117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="drs_api_0151__p15294101410512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row629211415517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_api_0151__p19294814165116">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_api_0151__p1329491455115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_api_0151__p1629481415110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_api_0151__p1585145445419">The content type.</p>
<p id="drs_api_0151__p123256415450">The default value is <strong id="drs_api_0151__b1428995814545">application/json</strong>.</p>
</td>
</tr>
<tr id="drs_api_0151__row6292111415515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_api_0151__p122952148516">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_api_0151__p7295111425112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_api_0151__p429521414510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_api_0151__p1296141417512">User token obtained from IAM.</p>
</td>
</tr>
<tr id="drs_api_0151__row229281455113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="drs_api_0151__p1529617143518">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="drs_api_0151__p4296121416513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="drs_api_0151__p8296141425110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="drs_api_0151__p1529661455110">Request language type</p>
<p id="drs_api_0151__p68691956125917">Default value: <strong id="drs_api_0151__b1786912566599">en-us</strong></p>
<p id="drs_api_0151__p1386915625912">Values:</p>
<ul id="drs_api_0151__ul1586965613591"><li id="drs_api_0151__li1886915655910"><strong id="drs_api_0151__b158691656145912">en-us</strong></li><li id="drs_api_0151__li17869125685916"><strong id="drs_api_0151__b12869175615914">zh-cn</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_api_0151__row152971314185117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_api_0151__p10297121414517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="drs_api_0151__p14298151415120">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="drs_api_0151__p429851475117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="drs_api_0151__p62981614145113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row15297151411518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_api_0151__p829871412519">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_api_0151__p1629871415111">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_api_0151__p152991614115116">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_api_0151__p92991143516">Querying task details in batches</p>
</td>
</tr>
<tr id="drs_api_0151__row1929701420516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_api_0151__p20299214205113">page_req</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_api_0151__p1229911147514">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_api_0151__p163001514175115"><a href="#drs_api_0151__request_PageReq">PageReq</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_api_0151__p23001214145110">Pagination information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__request_PageReq"></a><a name="request_PageReq"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__request_PageReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PageReq</caption><thead align="left"><tr id="drs_api_0151__row1300121417511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="drs_api_0151__p133011214125112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="drs_api_0151__p8301314185119">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="drs_api_0151__p13301914125111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="drs_api_0151__p1030141455112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row103001814165116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_api_0151__p153021014195113">cur_page</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_api_0151__p63021014125117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_api_0151__p530213144518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_api_0151__p43026148510">Current page number, which cannot exceed the maximum number of pages. (Number of pages = Number of transferred job IDs/Number of tasks on each page)</p>
<ul id="drs_api_0151__ul151821013438"><li id="drs_api_0151__li6182100114310">Minimum value: <strong id="drs_api_0151__b178264076484951">1</strong>.</li><li id="drs_api_0151__li171827034315">Default value: <strong id="drs_api_0151__b168137484884951">1</strong></li></ul>
</td>
</tr>
<tr id="drs_api_0151__row1230018148519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="drs_api_0151__p230331465116">per_page</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="drs_api_0151__p1930314147512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="drs_api_0151__p53031814105113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="drs_api_0151__p10304314195117">Number of items on each page. If this parameter is set to <strong id="drs_api_0151__b1499110143426">0</strong>, all items are obtained.</p>
<ul id="drs_api_0151__ul1764124019337"><li id="drs_api_0151__li264174063319">Minimum value: <strong id="drs_api_0151__b11304171435113">0</strong></li><li id="drs_api_0151__li1364154013312">Maximum value: <strong id="drs_api_0151__b230411435112">100</strong></li><li id="drs_api_0151__li464144093319">Default value: <strong id="drs_api_0151__b2307023174219">5</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_api_0151__section830414149511"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_api_0151__p18305121445114"><strong id="drs_api_0151__b1305414155112">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="drs_api_0151__row230511415513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="drs_api_0151__p630614140514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="drs_api_0151__p143061914115118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="drs_api_0151__p12306614175117">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row73058144519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="drs_api_0151__p130691445115">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="drs_api_0151__p13306171425115">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="drs_api_0151__p2307514195119">Number of tasks.</p>
</td>
</tr>
<tr id="drs_api_0151__row18305181415510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="drs_api_0151__p133071714165112">results</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="drs_api_0151__p1730717143512">Array of <a href="#drs_api_0151__response_QueryJobResp">QueryJobResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="drs_api_0151__p930711419518">Task details.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_QueryJobResp"></a><a name="response_QueryJobResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_QueryJobResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>QueryJobResp</caption><thead align="left"><tr id="drs_api_0151__row430810149519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="drs_api_0151__p1731021415516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="drs_api_0151__p19310914195118">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="drs_api_0151__p93101149516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row63088146514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p183111814175113">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p8312111475112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p143131514105111">Task ID.</p>
</td>
</tr>
<tr id="drs_api_0151__row93081014155114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p8313714175111">parent_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1631371495117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p0313111417514">Parent task ID.</p>
</td>
</tr>
<tr id="drs_api_0151__row33086148517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p163145145512">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p6314121455116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p173149142516">Task name.</p>
</td>
</tr>
<tr id="drs_api_0151__row1330841455115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p831461465115">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p931551417514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p33154145517">Task status. Values:</p>
<ul id="drs_api_0151__ul123155145517"><li id="drs_api_0151__li2315121410514"><strong id="drs_api_0151__b80016687384951">CREATING</strong>: The task is being created.</li><li id="drs_api_0151__li14316131415117"><strong id="drs_api_0151__b48593447684951">CREATE_FAILED</strong>: The task fails to be created.</li><li id="drs_api_0151__li83161614125115"><strong id="drs_api_0151__b124884426684951">CONFIGURATION</strong>: The task is being configured.</li><li id="drs_api_0151__li13161014115115"><strong id="drs_api_0151__b93592616443">STARTJOBING</strong>: The task is being started.</li><li id="drs_api_0151__li03169149515"><strong id="drs_api_0151__b58817553584951">WAITING_FOR_START</strong>: The task is waiting to be started.</li><li id="drs_api_0151__li163173148514"><strong id="drs_api_0151__b138295567384951">START_JOB_FAILED</strong>: The task fails to be started.</li><li id="drs_api_0151__li031711420519"><strong id="drs_api_0151__b1219195794418">FULL_TRANSFER_STARTED</strong>: Full migration is in progress, and the DR scenario is initialized.</li><li id="drs_api_0151__li14317314175113"><strong id="drs_api_0151__b833622494517">FULL_TRANSFER_FAILED</strong>: Full migration failed. Initialization failed in the DR scenario.</li><li id="drs_api_0151__li8317161416511"><strong id="drs_api_0151__b199941521194615">FULL_TRANSFER_COMPLETE</strong>: Full migration is complete, and the initialization is complete in the DR scenario.</li><li id="drs_api_0151__li19317191445114"><strong id="drs_api_0151__b1714773274612">INCRE_TRANSFER_STARTED</strong>: Incremental migration is being performed, and the DR task is in progress.</li><li id="drs_api_0151__li4318111485114"><strong id="drs_api_0151__b392045354610">INCRE_TRANSFER_FAILED</strong>: Incremental migration fails and a DR exception occurs.</li><li id="drs_api_0151__li33181414155110"><strong id="drs_api_0151__b106287626084951">RELEASE_RESOURCE_STARTED</strong>: The task is being stopped.</li><li id="drs_api_0151__li53181314135115"><strong id="drs_api_0151__b141789268284951">RELEASE_RESOURCE_FAILED</strong>: Stop task failed.</li><li id="drs_api_0151__li931801495114"><strong id="drs_api_0151__b102017217684951">RELEASE_RESOURCE_COMPLETE</strong>: The task is stopped.</li><li id="drs_api_0151__li1531819140515"><strong id="drs_api_0151__b30245827584951">CHANGE_JOB_STARTED</strong>: The task is being changed.</li><li id="drs_api_0151__li4319121413515"><strong id="drs_api_0151__b203697645884951">CHANGE_JOB_FAILED</strong>: Change task failed.</li><li id="drs_api_0151__li53231014115111"><strong id="drs_api_0151__b167608994484951">CHILD_TRANSFER_STARTING</strong>: The subtask is being started.</li><li id="drs_api_0151__li15323514125111"><strong id="drs_api_0151__b24574777984951">CHILD_TRANSFER_STARTED</strong>: The subtask is being migrated.</li><li id="drs_api_0151__li17323414145117"><strong id="drs_api_0151__b76585444584951">CHILD_TRANSFER_COMPLETE</strong>: The subtask migration is complete.</li><li id="drs_api_0151__li1832315142518"><strong id="drs_api_0151__b1943347484951">CHILD_TRANSFER_FAILED</strong>: Migrate subtask failed.</li><li id="drs_api_0151__li193241614125111"><strong id="drs_api_0151__b193097495684951">RELEASE_CHILD_TRANSFER_STARTED</strong>: The subtask is being stopped.</li><li id="drs_api_0151__li8324201410517"><strong id="drs_api_0151__b23465457784951">RELEASE_CHILD_TRANSFER_COMPLETE</strong>: The subtask is complete.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row1430801425116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1032491411518">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p193241514195110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p532510142513">Description.</p>
</td>
</tr>
<tr id="drs_api_0151__row12308201475113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1332541410513">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p143252147518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1325181485112">Creation time, in timestamp format.</p>
</td>
</tr>
<tr id="drs_api_0151__row73081145511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p173266145512">task_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1632631417516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p12326131416511">Task mode. Values:</p>
<ul id="drs_api_0151__ul836111315510"><li id="drs_api_0151__li10361111395115"><strong id="drs_api_0151__b9169191325818">FULL_TRANS</strong>: full migration</li><li id="drs_api_0151__li143621613135120"><strong id="drs_api_0151__b76797161581">INCR_TRANS</strong>: incremental migration</li><li id="drs_api_0151__li4362713115114"><strong id="drs_api_0151__b131013204581">FULL_INCR_TRANS</strong>: full+incremental migration</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row03081714135111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p8327414195111">source_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1932711410519"><a href="#drs_api_0151__response_Endpoint">Endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p17328181465115">Source database information.</p>
</td>
</tr>
<tr id="drs_api_0151__row14309181495120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p03281148513">dmq_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p6328161465116"><a href="#drs_api_0151__response_Endpoint">Endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1632813149519">DMQ information body.</p>
</td>
</tr>
<tr id="drs_api_0151__row93091114165112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p203291614105112">source_sharding</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p232916145517">Array of <a href="#drs_api_0151__response_Endpoint">Endpoint</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p2032941465115">Information about the physical source database.</p>
</td>
</tr>
<tr id="drs_api_0151__row12309111416515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1432951415115">target_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1433051495117"><a href="#drs_api_0151__response_Endpoint">Endpoint</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p63301814205110">Information body of the destination database.</p>
</td>
</tr>
<tr id="drs_api_0151__row3309131413514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p193301114155113">net_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1633091485118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p123301414135116">Network type. Values:</p>
<ul id="drs_api_0151__ul153311114195115"><li id="drs_api_0151__li1433161415117"><strong id="drs_api_0151__b143314143512">vpn</strong></li><li id="drs_api_0151__li1533110149511"><strong id="drs_api_0151__b4331101411517">vpc</strong></li><li id="drs_api_0151__li153311514165115"><strong id="drs_api_0151__b0331181410519">eip</strong></li></ul>
</td>
</tr>
<tr id="drs_api_0151__row8309191485119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p53326148517">failed_reason</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1533217147516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p5332161495118">Failure cause.</p>
</td>
</tr>
<tr id="drs_api_0151__row73093145514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p8332181414515">inst_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1332101465115"><a href="#drs_api_0151__response_InstInfo">InstInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1833311416515">Replication instance information.</p>
</td>
</tr>
<tr id="drs_api_0151__row1230981445119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p18333414195116">actual_start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p9333191445119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p0333121410514">Start time, in timestamp format.</p>
</td>
</tr>
<tr id="drs_api_0151__row6309181425111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p11334161416518">full_transfer_complete_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p733451445114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p333491485117">Full migration completion time, in timestamp format.</p>
</td>
</tr>
<tr id="drs_api_0151__row12309214175114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p10334514145117">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p0334181475117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p7335181495118">Update time, in timestamp format.</p>
</td>
</tr>
<tr id="drs_api_0151__row19309181485114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p123351914105116">job_direction</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1833517147510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p03361414135113">Task direction. Values:</p>
<ul id="drs_api_0151__ul1533584104514"><li id="drs_api_0151__li33354464512"><strong id="drs_api_0151__b68556619184951">up</strong>: The current cloud is the standby cloud in the DR and to-the-cloud scenarios.</li><li id="drs_api_0151__li6336164104516"><strong id="drs_api_0151__b56654733184951">down</strong>: The current cloud is the active cloud in the DR and out-of-cloud scenarios.</li><li id="drs_api_0151__li11336184174518"><strong id="drs_api_0151__b15202119192012">non-dbs</strong>: self-built databases.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row13092140515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p5337131435116">db_use_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p13371914115114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p93371014165114">Migration scenario Values:</p>
<ul id="drs_api_0151__ul11338714155118"><li id="drs_api_0151__li12338114125111"><strong id="drs_api_0151__b134813591417">migration</strong>: real-time migration.</li><li id="drs_api_0151__li433811147513"><strong id="drs_api_0151__b67422029">sync</strong>: real-time synchronization.</li><li id="drs_api_0151__li14338121410512"><strong id="drs_api_0151__b8550851821">cloudDataGuard</strong>: real-time disaster recovery.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row1830913149516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p8338131417517">need_restart</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p53392144510">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p13339111414512">Whether the instance needs to be restarted.</p>
</td>
</tr>
<tr id="drs_api_0151__row193091314105116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p3339141419517">is_target_readonly</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1834061495112">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p12340114155115">Whether the destination instance is restricted to read-only.</p>
</td>
</tr>
<tr id="drs_api_0151__row2030921415116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p13340414135112">conflict_policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p6340101412512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p18341171420517">Conflict policy. Values:</p>
<ul id="drs_api_0151__ul53411114155118"><li id="drs_api_0151__li7341201418517"><strong id="drs_api_0151__b31804311327">stop</strong>: The conflict fails.</li><li id="drs_api_0151__li3341111410513"><strong id="drs_api_0151__b95471235126">overwrite</strong>: Conflicting data is overwritten.</li><li id="drs_api_0151__li10341201445110"><strong id="drs_api_0151__b18828538726">ignore</strong>: The conflict is ignored.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row430951445113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p163426142513">filter_ddl_policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1342914165117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p16342171415120">DDL filtering policy. Values:</p>
<ul id="drs_api_0151__ul434211412513"><li id="drs_api_0151__li1534361415116"><strong id="drs_api_0151__b149948380513">drop_database</strong>: Filters DDLs.</li><li id="drs_api_0151__li10343514135118"><strong id="drs_api_0151__b112081913562">drop_databasefilter_all</strong>: Filters out all DLLs.</li><li id="drs_api_0151__li7343171410513"><strong id="drs_api_0151__b1574243374613">""</strong>: No filter.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row5309214135118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p9738114145117">speed_limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p11738191475118">Array of <a href="#drs_api_0151__response_SpeedLimitInfo">SpeedLimitInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p187388141515">Migration speed limit.</p>
</td>
</tr>
<tr id="drs_api_0151__row113095145518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1873820147517">schema_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1573820146515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p173891445116">Migration schemes. Values:</p>
<ul id="drs_api_0151__ul77380143511"><li id="drs_api_0151__li17382147512"><strong id="drs_api_0151__b77771253578">Replication</strong>: primary/standby replication.</li><li id="drs_api_0151__li773911485114"><strong id="drs_api_0151__b183769576715">Tungsten</strong>: parses logs.</li><li id="drs_api_0151__li1673921435115"><strong id="drs_api_0151__b16031407813">PGBaseBackup</strong>: PostgreSQL backup.</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row143091514195116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p473921485115">node_num</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p167391114195110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p57397147510">The number of nodes.</p>
</td>
</tr>
<tr id="drs_api_0151__row2030915148515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1373941465111">object_switch</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p14739114115111">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p14739814185114">Whether to select objects.</p>
</td>
</tr>
<tr id="drs_api_0151__row1730920148519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p18739914165111">master_job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p6739414125110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p107394146518">Main task ID</p>
</td>
</tr>
<tr id="drs_api_0151__row1730931495112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p2739101485115">full_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1074016148517">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p4740121425116">Full snapshot mode.</p>
</td>
</tr>
<tr id="drs_api_0151__row230919141519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p17740914165120">struct_trans</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p874061485117">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1074015146512">Whether to migrate the structure.</p>
</td>
</tr>
<tr id="drs_api_0151__row83094149517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p19740514105117">index_trans</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1474041455119">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p174020147515">Whether to migrate indexes.</p>
</td>
</tr>
<tr id="drs_api_0151__row8309201419515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p9740121435117">replace_definer</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p147401114175119">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p127401314175115">Whether to replace the definer with the user of the destination database.</p>
</td>
</tr>
<tr id="drs_api_0151__row1830941411517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1074019141516">migrate_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p274091412518">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p20740614135118">Whether to migrate users.</p>
</td>
</tr>
<tr id="drs_api_0151__row20309414145118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1274101465112">sync_database</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p37411814125117">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p5741514105115">Whether to perform database-level synchronization.</p>
</td>
</tr>
<tr id="drs_api_0151__row4309161416514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p127411414105112">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p5741151495114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1574191425116">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_api_0151__row4309161412514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p19741181475117">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p13741214195112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p774114145511">Error message, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_api_0151__row1330911413514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p274181445113">target_root_db</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1741914205119"><a href="#drs_api_0151__response_DefaultRootDb">DefaultRootDb</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p874117147517">Information about the root node database of the destination instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row1309191415512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p167413146514">az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p474271415110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p15742514175113">AZ where the node is located.</p>
</td>
</tr>
<tr id="drs_api_0151__row83091914155110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1274221415512">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p574261415116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p17742181418517">VPC to which the node belongs.</p>
</td>
</tr>
<tr id="drs_api_0151__row530921405118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1174251405118">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p117421914195116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p174281412510">Subnet where the node is located.</p>
</td>
</tr>
<tr id="drs_api_0151__row1309114155118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p2074291411517">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1674201414515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p974221495114">Security group to which the node belongs.</p>
</td>
</tr>
<tr id="drs_api_0151__row1530918147518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p774351411517">multi_write</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p117431314125120">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p19743101412517">Whether the task is a multi-active DR task. The value is <strong id="drs_api_0151__b38015151107">true</strong> when the task is a dual-active DR task.</p>
</td>
</tr>
<tr id="drs_api_0151__row8309191465111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p274311146519">support_ip_v6</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p11743714135112">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p174391465111">Whether IPv6 is supported</p>
</td>
</tr>
<tr id="drs_api_0151__row123091614195116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p16743214145110">inherit_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p5743191445112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p6743191418513">Inherited task ID.</p>
</td>
</tr>
<tr id="drs_api_0151__row1230961475112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p11743181445118">gtid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p137433141516">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p3743121425114">GTID set of breakpoints.</p>
</td>
</tr>
<tr id="drs_api_0151__row183091714125110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p320921215">alarm_notify</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p18209214113"><a href="#drs_api_0151__response_QuerySmnInfoResp">QuerySmnInfoResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p5744161415511">Exception notification settings.</p>
</td>
</tr>
<tr id="drs_api_0151__row157283154919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p872331174911">is_multi_az</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p19721631154911">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p6728312497">Whether the task is a cross-AZ synchronization task.</p>
</td>
</tr>
<tr id="drs_api_0151__row164878186502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p164871518175015">az_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p10487111835012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p14487818195018">AZ name of the node.</p>
</td>
</tr>
<tr id="drs_api_0151__row53972511509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p73971251165018">master_az</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p1397135125018">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p13397851175019">Primary AZ of the cross-AZ task.</p>
</td>
</tr>
<tr id="drs_api_0151__row111051523125120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p810582313518">slave_az</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p17105723145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p1610512345115">Standby AZ of the cross-AZ task.</p>
</td>
</tr>
<tr id="drs_api_0151__row10675355115115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p1567505514519">node_role</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p667535520512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p16675655175119">Primary/Standby role of a task.</p>
</td>
</tr>
<tr id="drs_api_0151__row15291215525"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="drs_api_0151__p18291721205212">incre_start_position</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="drs_api_0151__p9297212522">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="drs_api_0151__p92942175214">Start point of an incremental task.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_Endpoint"></a><a name="response_Endpoint"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_Endpoint" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Endpoint</caption><thead align="left"><tr id="drs_api_0151__row11355191413517"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="drs_api_0151__p574416146511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="drs_api_0151__p67441314125110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="drs_api_0151__p7744121417513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row635561418511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p374441413517">db_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p157449145512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p97448147512">Database type. Values:</p>
<ul id="drs_api_0151__ul134815414517"><li id="drs_api_0151__li83489412453"><strong id="drs_api_0151__b153480474518">mysql</strong></li><li id="drs_api_0151__li10348146457"><strong id="drs_api_0151__b2348164124513">mongodb</strong></li><li id="drs_api_0151__li136314246411"><strong id="drs_api_0151__b8636249413">taurus</strong></li></ul>
<ul id="drs_api_0151__ul1490234791618"><li id="drs_api_0151__li134671052114713"><strong id="drs_api_0151__b9467752164717">postgresql</strong></li></ul>
</td>
</tr>
<tr id="drs_api_0151__row113551414195113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p1874511147515">az_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p2745101418510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p14745101410510">Code of the AZ where the database is located.</p>
</td>
</tr>
<tr id="drs_api_0151__row19355171415116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p9745131410518">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p57451514115118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p12745414115113">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.</p>
</td>
</tr>
<tr id="drs_api_0151__row17356191415114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p137451514125113">inst_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p5745121415120">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p18745201475119">DB instance ID. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row193568143511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p127453144514">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p15746181410519">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p5746714155111">ID of the VPC where the database is located.</p>
</td>
</tr>
<tr id="drs_api_0151__row8356141425118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p167461146516">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p1274601465113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p374617143514">ID of the subnet where the database is located.</p>
</td>
</tr>
<tr id="drs_api_0151__row11356314185110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p207468143516">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p14746121485118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p1174612140513">ID of the security group to which the database belongs.</p>
</td>
</tr>
<tr id="drs_api_0151__row14356181415519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p12746201435119">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p37461514115117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p6746214115117">Project ID of an RDS DB instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row5356314185113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p974731455113">db_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p16747314125118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p1774751465120">Database password.</p>
</td>
</tr>
<tr id="drs_api_0151__row123562014145113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p3747171425113">db_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p1474741445113">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p20747101415117">Database port. The value is an integer ranging from 1 to 65535.</p>
</td>
</tr>
<tr id="drs_api_0151__row635661445111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p17747101415515">db_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p15747914175119">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p074721418515">Database user.</p>
</td>
</tr>
<tr id="drs_api_0151__row93569145514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p5747111425118">inst_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p27471414135114">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p87473142512">The name of an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row15356714115117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p674711435116">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p127484143515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p27481914115120">Database IP address.</p>
</td>
</tr>
<tr id="drs_api_0151__row135611145515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p474813142516">mongo_ha_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p174851495113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p6748614155113">MongoDB HA mode.</p>
</td>
</tr>
<tr id="drs_api_0151__row1935631435117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p15748111419512">ssl_cert_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p15748161412513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p7749181465118">SSL certificate password. The certificate file name extension is .p12.</p>
</td>
</tr>
<tr id="drs_api_0151__row18357101415112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p174971475115">ssl_cert_check_sum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p374971465118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p18749614185111">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_api_0151__row835701418519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p1749111415518">ssl_cert_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p147495149514">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p1749114165117">SSL certificate content, which is encrypted using Base64.</p>
</td>
</tr>
<tr id="drs_api_0151__row335711414516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p8749151475112">ssl_cert_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p1674901415112">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p57491714175111">SSL certificate name.</p>
</td>
</tr>
<tr id="drs_api_0151__row135741415510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p1874961411517">ssl_link</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p3749121415512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p1574931415519">Whether SSL is enabled.</p>
</td>
</tr>
<tr id="drs_api_0151__row6136192517548"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="drs_api_0151__p18518818114417">cluster_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="drs_api_0151__p35180184443">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="drs_api_0151__p6518161818447">For MongoDB 4.0 or later, if the cluster instance cannot obtain the IP address of the sharded node, set <strong id="drs_api_0151__b13247191283513">source_endpoint</strong> to <strong id="drs_api_0151__b4259212133517">Sharding4.0+</strong>.</p>
<p id="drs_api_0151__p5518131824411">Default value: <strong id="drs_api_0151__b9832102115354">Sharding4.0+</strong></p>
<p id="drs_api_0151__p951841834413">Enumerated value:</p>
<ul id="drs_api_0151__ul1651941813447"><li id="drs_api_0151__li1351941810446"><strong id="drs_api_0151__b751911813441">Sharding4.0+</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_InstInfo"></a><a name="response_InstInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_InstInfo" frame="border" border="1" rules="all"><caption><b>Table 8 </b>InstInfo</caption><thead align="left"><tr id="drs_api_0151__row03698142515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="drs_api_0151__p11750314175119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="drs_api_0151__p27501214155116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="drs_api_0151__p18750111435112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row9369314155120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p13750101425120">engine_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p17750121435110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p157502148515">Engine type of a DRS task. Values:</p>
<ul id="drs_api_0151__ul1414913914338"><li id="drs_api_0151__li15149294334"><strong id="drs_api_0151__b931816263147">mysql</strong>: used for migration and synchronization from MySQL to MySQL</li><li id="drs_api_0151__li4150890335"><strong id="drs_api_0151__b889762791417">mongodb</strong>: used for migration from MongoDB to DDS</li><li id="drs_api_0151__li12150497336"><strong id="drs_api_0151__b12276143018147">cloudDataGuard-mysql</strong>: used for DR from MySQL to MySQL</li><li id="drs_api_0151__li3150139133314"><strong id="drs_api_0151__b9583183714145">mysql-to-taurus</strong>: used for synchronization from MySQL to GaussDB(for MySQL) primary/standby</li><li id="drs_api_0151__li0352957122719"><strong id="drs_api_0151__b6259124571417">postgresql</strong>: used for synchronization from PostgreSQL to PostgreSQL</li></ul>
</td>
</tr>
<tr id="drs_api_0151__row336991435119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p15751714105118">inst_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p77514141511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p5751161414514">DB instance type. Values:</p>
<ul id="drs_api_0151__ul1475181412510"><li id="drs_api_0151__li5751121416517"><strong id="drs_api_0151__b275141415514">high</strong></li></ul>
</td>
</tr>
<tr id="drs_api_0151__row183691214135118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p4751141475114">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p9751201412515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p375114147518">Private IP address of the replication instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row2036941485117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p127511514125111">public_ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p12752111465116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p137527147519">EIP of the replication instance.</p>
</td>
</tr>
<tr id="drs_api_0151__row136981485120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p675212141519">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p15752151445115">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p20752181410514">Scheduled start time of a replication instance task.</p>
</td>
</tr>
<tr id="drs_api_0151__row203691714205119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p107521214195112">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p8752191475113">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p13752131412514">Replication instance status. Values:</p>
<ul id="drs_api_0151__ul77525149518"><li id="drs_api_0151__li2752014125116"><strong id="drs_api_0151__b2752414195116">active</strong></li><li id="drs_api_0151__li1275217140514"><strong id="drs_api_0151__b1675261410514">deleted</strong></li></ul>
</td>
</tr>
<tr id="drs_api_0151__row20369141435115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="drs_api_0151__p8752191455118">volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="drs_api_0151__p57529148510">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="drs_api_0151__p2753181418515">Storage space of a replication instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_SpeedLimitInfo"></a><a name="response_SpeedLimitInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_SpeedLimitInfo" frame="border" border="1" rules="all"><caption><b>Table 9 </b>SpeedLimitInfo</caption><thead align="left"><tr id="drs_api_0151__row337481405113"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="drs_api_0151__p37531014195111">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="drs_api_0151__p19753614115119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="drs_api_0151__p18753111445112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row1637414146515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="drs_api_0151__p14753101412517">begin</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="drs_api_0151__p19753814155118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="drs_api_0151__p1675318147518">Start time of flow control.</p>
</td>
</tr>
<tr id="drs_api_0151__row1537412146515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="drs_api_0151__p207531414205116">end</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="drs_api_0151__p1975391418515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="drs_api_0151__p475316145510">End time of flow control.</p>
</td>
</tr>
<tr id="drs_api_0151__row1137451475119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="drs_api_0151__p9753151410518">is_utc</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="drs_api_0151__p12754014115113">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="drs_api_0151__p117541914165114">Whether the UTC time is used.</p>
</td>
</tr>
<tr id="drs_api_0151__row1537431465116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="drs_api_0151__p375421475110">speed</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="drs_api_0151__p57541014105111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="drs_api_0151__p1775431414516">Flow control</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_DefaultRootDb"></a><a name="response_DefaultRootDb"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_DefaultRootDb" frame="border" border="1" rules="all"><caption><b>Table 10 </b>DefaultRootDb</caption><thead align="left"><tr id="drs_api_0151__row1377171475114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="drs_api_0151__p15754111405112">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="drs_api_0151__p1275410145516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="drs_api_0151__p1754131416518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row53771014195116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="drs_api_0151__p137542014195114">db_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="drs_api_0151__p18754514175117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="drs_api_0151__p1754121412514">Database name.</p>
</td>
</tr>
<tr id="drs_api_0151__row3377614125119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="drs_api_0151__p16754111413519">db_encoding</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="drs_api_0151__p7755191419515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="drs_api_0151__p167551414185116">Encoding format</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_QuerySmnInfoResp"></a><a name="response_QuerySmnInfoResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_QuerySmnInfoResp" frame="border" border="1" rules="all"><caption><b>Table 11 </b>QuerySmnInfoResp</caption><thead align="left"><tr id="drs_api_0151__row3811219110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="drs_api_0151__p1121471116"><strong id="drs_api_0151__b1487817432455">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="drs_api_0151__p10214111718"><strong id="drs_api_0151__b51979559455">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="drs_api_0151__p121431314"><strong id="drs_api_0151__b77026577450">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row17811611314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p17214111519">subscriptions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p1221411611">Array of <a href="#drs_api_0151__response_SubscriptionInfo">SubscriptionInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p5214211913">SMN information.</p>
</td>
</tr>
<tr id="drs_api_0151__row1081218112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p72142011919">topic_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p12141612012">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p182142111114">Topic name.</p>
</td>
</tr>
<tr id="drs_api_0151__row20811811418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p182144116110">delay_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p152141914120">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p82141211112">Subscription delay.</p>
</td>
</tr>
<tr id="drs_api_0151__row982517112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p192148119113">rto_delay</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p421414116120">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p202141311915">RTO delay.</p>
</td>
</tr>
<tr id="drs_api_0151__row10821815116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p202141911613">rpo_delay</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p162141611511">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p32143113119">RPO delay.</p>
</td>
</tr>
<tr id="drs_api_0151__row88215113111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="drs_api_0151__p112151711114">alarm_to_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="drs_api_0151__p142151515112">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="drs_api_0151__p921531312">Whether to notify users of alarms.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_api_0151__response_SubscriptionInfo"></a><a name="response_SubscriptionInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__response_SubscriptionInfo" frame="border" border="1" rules="all"><caption><b>Table 12 </b>SubscriptionInfo</caption><thead align="left"><tr id="drs_api_0151__row984515110"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="drs_api_0151__p102157110111"><strong id="drs_api_0151__b173802424469">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="drs_api_0151__p12215719115"><strong id="drs_api_0151__b3878144316460">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="drs_api_0151__p142151911110"><strong id="drs_api_0151__b12799134444610">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row28471718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="drs_api_0151__p142153115119">endpoints</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="drs_api_0151__p42151213120">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="drs_api_0151__p142151411314">SMS or email list.</p>
</td>
</tr>
<tr id="drs_api_0151__row1841411714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="drs_api_0151__p32151810116">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="drs_api_0151__p42156114118">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="drs_api_0151__p1921519110110">Notification methods. <strong id="drs_api_0151__b18939131117477">sms</strong>: SMS; <strong id="drs_api_0151__b61611618194711">email</strong>: Email.</p>
<p id="drs_api_0151__p821512114117">Enumerated value:</p>
<ul id="drs_api_0151__ul102151211619"><li id="drs_api_0151__li11215191011"><strong id="drs_api_0151__b62151811415">sms</strong></li><li id="drs_api_0151__li142151811819"><strong id="drs_api_0151__b1921518114118">email</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_api_0151__section17755131485114"><h4 class="sectiontitle">Example Request</h4><p id="drs_api_0151__p1075510141519">Request for querying task details:</p>
<pre class="screen" id="drs_api_0151__screen2972115165211">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-detail</pre>
<pre class="screen" id="drs_api_0151__screen1983101155212">{
"jobs" : [ "24834eb6-be30-464e-a299-f7aa730jb101", "140b5236-88ad-43c8-811c-1268453jb101" ],
"page_req" : {
"cur_page" : 1,
"per_page" : 10
}
}</pre>
</div>
<div class="section" id="drs_api_0151__section8756171475112"><h4 class="sectiontitle">Example Response</h4><p id="drs_api_0151__p475631413517"><strong id="drs_api_0151__b6756131416511">Status code: 200</strong></p>
<p id="drs_api_0151__p575618141519">OK</p>
<pre class="screen" id="drs_api_0151__screen1775631418518">{
"count" : 2,
"results" : [ {
"id" : "24834eb6-be30-464e-a299-f7aa730jb101",
"name" : "DRS-3999-lws",
"status" : "STARTJOBING",
"description" : "",
"create_time" : "1608519469412",
"task_type" : "FULL_INCR_TRANS",
"source_endpoint" : {
"ip" : "172.22.74.56",
"region" : "eu-de",
"db_type" : "mysql",
"db_port" : 3306,
"ssl_link" : false,
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
"db_user" : "root"
},
"target_endpoint" : {
"ip" : "172.21.176.219",
"region" : "eu-de",
"db_type" : "mysql",
"db_port" : 3306,
"ssl_link" : false,
"inst_id" : "3ef57dbcc8db478a9e346d26ef2575bfin01",
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
"inst_name" : "rds-lws-target",
"db_user" : "root",
"vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
"subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c"
},
"inst_info" : {
"ip" : "172.16.213.101",
"inst_type" : "high",
"engine_type" : "mysql",
"volume_size" : 100,
"public_ip" : "10.154.219.202",
"start_time" : "0"
},
"actual_start_time" : "1608520069393",
"update_time" : "1608520068979",
"job_direction" : "up",
"db_use_type" : "migration",
"need_restart" : false,
"is_target_readonly" : true,
"speed_limit" : [ ],
"schema_type" : "Tungsten",
"object_switch" : true,
"replace_definer" : true,
"migrate_user" : false,
"az_code" : "az2xahz",
"vpc_id" : "0ff8df7b-f0e9-4b16-ac16-1db3dacb69e4",
"subnet_id" : "f857d371-2f03-4622-85f6-2b7d42d0d82c",
"security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
"support_ip_v6" : false
}, {
"id" : "140b5236-88ad-43c8-811c-1268453jb101",
"name" : "DRS-0042-linxiaolu",
"status" : "CONFIGURATION",
"description" : "",
"create_time" : "1608366204171",
"task_type" : "FULL_INCR_TRANS",
"source_endpoint" : {
"ip" : "192.168.0.27",
"region" : "eu-de",
"db_type" : "mysql",
"db_port" : 3306,
"ssl_link" : false,
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
"db_user" : "root"
},
"target_endpoint" : {
"ip" : "192.168.0.131",
"region" : "eu-de",
"db_type" : "mysql",
"db_port" : 3306,
"ssl_link" : false,
"inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
"inst_name" : "rds-1417-lxl",
"db_user" : "root",
"vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
"subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417"
},
"inst_info" : {
"ip" : "192.168.0.229",
"status" : "ACTIVE",
"inst_type" : "high",
"engine_type" : "mysql",
"volume_size" : 100,
"public_ip" : "10.154.219.72",
"start_time" : "0"
},
"actual_start_time" : "1608369232412",
"full_transfer_complete_time" : "1608369510202",
"update_time" : "1608517066434",
"job_direction" : "up",
"db_use_type" : "migration",
"need_restart" : false,
"is_target_readonly" : true,
"speed_limit" : [ ],
"schema_type" : "Tungsten",
"object_switch" : false,
"replace_definer" : true,
"migrate_user" : false,
"az_code" : "az2xahz",
"vpc_id" : "65f0391c-0582-44a6-aa50-248f97ed82e1",
"subnet_id" : "352ad828-3467-4f03-987a-c55a5a9dd417",
"security_group_id" : "d90c971b-4b9d-402c-9c59-5c239389b8dd",
"support_ip_v6" : false
} ]
}</pre>
</div>
<div class="section" id="drs_api_0151__section2765101415516"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0151__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_api_0151__row7395161417517"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="drs_api_0151__p12765614165112">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_api_0151__p18765171495114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_api_0151__row1039511413514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="drs_api_0151__p17765161420514">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="drs_api_0151__p1576518143516">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_api_0151__section9765111411513"><h4 class="sectiontitle">Error Code</h4><p id="drs_api_0151__p177655145517">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