vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/drs/api-ref/drs_03_0136.html
Wang , Deng Ke 231618c804 DRS API 2.0.38SP23 version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-24 16:49:13 +00:00

443 lines
32 KiB
HTML
Raw Blame History

<a name="drs_03_0136"></a><a name="drs_03_0136"></a>
<h1 class="topictitle1">Creating a Comparison Task</h1>
<div id="body10127111055612"><div class="section" id="drs_03_0136__section2012751085620"><h4 class="sectiontitle">Function</h4><p id="drs_03_0136__p9128111013562">This API is used to create a comparison task</p>
</div>
<div class="section" id="drs_03_0136__section41287102561"><h4 class="sectiontitle">Constraints</h4><p id="drs_03_0136__p61281610155618">In the current version, a comparison task can be created only when the MySQL DR task is in the DR progress. The parent task cannot call the API.</p>
</div>
<div class="section" id="drs_03_0136__section71280108566"><h4 class="sectiontitle">URI</h4><p id="drs_03_0136__p19129151010568">POST /v3/{project_id}/jobs/create-compare-task</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table11311010175611" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0136__row1613014102564"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0136__p513210109565">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_0136__p513217101563">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_0136__p17132141075614">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_0136__p1513316101566">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row31301810155613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0136__p1113371035611">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0136__p131331101568">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0136__p19133310165618">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0136__p71335106568">Project ID of a tenant in a region</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0136__section5821631125220"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table394019155820" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0136__row6821131155218"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_03_0136__p188221531195213">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_0136__p582220313520">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_0136__p08221331155210">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_0136__p5822193111528">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row68211131195217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0136__p98221431105217">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0136__p282333120527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0136__p198231931125213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0136__p131061057125012">The content type.</p>
<p id="drs_03_0136__p123256415450">The default value is <strong id="drs_03_0136__b5406140135116">application/json</strong>.</p>
</td>
</tr>
<tr id="drs_03_0136__row882214318522"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0136__p982315317524">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_0136__p1182353111528">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0136__p48231731135211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0136__p682413113529">User token obtained from IAM.</p>
</td>
</tr>
<tr id="drs_03_0136__row108220313527"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0136__p138241631155215">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0136__p78241631185215">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0136__p15824231165216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0136__p17824173165218">Request language type</p>
<p id="drs_03_0136__p158241731145210">Default value: <strong id="drs_03_0136__b1182433118529">en-us</strong></p>
<p id="drs_03_0136__p1482418311526">Values:</p>
<ul id="drs_03_0136__ul138241831195217"><li id="drs_03_0136__li11824163105218"><strong id="drs_03_0136__b1682553145220">en-us</strong></li><li id="drs_03_0136__li78251231155212"><strong id="drs_03_0136__b9825113110521">zh-cn</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table894149195811" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0136__row138251431105219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_03_0136__p1482573135218">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_0136__p128261331145210">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_0136__p1182643115215">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_0136__p198261231155211">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row16825153116524"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0136__p188261531195216">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0136__p1682633125210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0136__p9826123165220">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0136__p19826193165218">Task ID.</p>
</td>
</tr>
<tr id="drs_03_0136__row13825631185217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0136__p882753115210">object_level_compare_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0136__p14827431125220">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0136__p12827143125215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0136__p19827183114523">Object-level comparison type. If the value is empty, the object-level comparison is not created. If both <strong id="drs_03_0136__b14532171153518">object_level_compare_type</strong> and <strong id="drs_03_0136__b1099641415350">data_level_compare_info</strong> are left empty, only the created comparison task list is queried.</p>
<p id="drs_03_0136__p10827113165219">Value:</p>
<ul id="drs_03_0136__ul5827123175220"><li id="drs_03_0136__li1082743185217"><strong id="drs_03_0136__b882713311528">objects</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0136__row7825163115216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0136__p88277315524">data_level_compare_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0136__p582723115526">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0136__p8828133110522"><a href="#drs_03_0136__table1594269185816">CreateDataLevelCompareReq</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0136__p18282311522">Data-level comparison information. If no data-level comparison is created, this parameter does not need to be transferred. If both <strong id="drs_03_0136__b29105402358">object_level_compare_type</strong> and <strong id="drs_03_0136__b150104643511">data_level_compare_info</strong> are left empty, only the created comparison task list is queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0136__table1594269185816"></a><a name="table1594269185816"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table1594269185816" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CreateDataLevelCompareReq</caption><thead align="left"><tr id="drs_03_0136__row188281931105211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="drs_03_0136__p582919319524">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_0136__p19829163112523">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="drs_03_0136__p982993113521">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="drs_03_0136__p48291312525">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row138281131145215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p13829113125212">conflict_policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p28291031175210">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p15830031125211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p1183093135218">Only one unfinished data-level comparison task can exist. This field determines how to process unfinished data-level comparison tasks. <strong id="drs_03_0136__b20766157173719">cancel</strong>: Cancel the task and create a new one. <strong id="drs_03_0136__b1342322511371">keep</strong>: Do not create a new task if the previous one is not complete.</p>
<p id="drs_03_0136__p1983093115211">Values:</p>
<ul id="drs_03_0136__ul98301531165212"><li id="drs_03_0136__li13830731135211"><strong id="drs_03_0136__b1830123110526">cancel</strong></li><li id="drs_03_0136__li20830123155211"><strong id="drs_03_0136__b983093105215">keep</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0136__row14828133115214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p12830163165213">compare_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p083063110527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p188305314529">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p13831153117522">Data-level comparison type. <strong id="drs_03_0136__b21211307413">lines</strong>: indicates row comparison. <strong id="drs_03_0136__b1812718013416">contents</strong>: value comparison.</p>
<p id="drs_03_0136__p12831113135214">Values:</p>
<ul id="drs_03_0136__ul983116310522"><li id="drs_03_0136__li4831103195217"><strong id="drs_03_0136__b88311731195212">lines</strong></li><li id="drs_03_0136__li38311431165219"><strong id="drs_03_0136__b783193115521">contents</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0136__row682811313524"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p8831143116521">compare_mode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p178311312527">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p108319314521">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p183193185210">Data-level comparison mode. If the value is empty, the object information needs to be transferred in <strong id="drs_03_0136__b1857371503816">compare_object_infos</strong> or <strong id="drs_03_0136__b1978711914382">compare_object_infos_with_token</strong>. <strong id="drs_03_0136__b12953122493817">quick_comparison</strong>: indicates quick comparison, which can be used only by whitelisted users.</p>
<p id="drs_03_0136__p683210313525">Default value: <strong id="drs_03_0136__b4855121133911">quick_comparison</strong></p>
<p id="drs_03_0136__p48326319525">Value:</p>
<ul id="drs_03_0136__ul1283253114526"><li id="drs_03_0136__li183263110521"><strong id="drs_03_0136__b17832143115524">quick_comparison</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0136__row7828831125212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p4832931175212">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p158327313524">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p18324319526">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p168322311529">Start time of a comparison task. If the value is empty, the task is started immediately.</p>
</td>
</tr>
<tr id="drs_03_0136__row7828031135218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p1833531105213">compare_object_infos</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p383333110524">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p98332311529">Array of <a href="#drs_03_0136__table149434955816">CompareObjectInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p783333111522">Data-level comparison object. In non-quick comparison mode, either <strong id="drs_03_0136__b197815124320">compare_object_infos</strong> or <strong id="drs_03_0136__b465816944319">compare_object_infos_with_token</strong> must be specified based on the migration scenario.</p>
</td>
</tr>
<tr id="drs_03_0136__row1828531195220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0136__p1383313318524">compare_object_infos_with_token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0136__p583393115525">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0136__p1083314311523">Array of <a href="#drs_03_0136__table199441591587">CompareObjectInfoWithToken</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0136__p1834133115520">Object for data-level comparison (Cassandra DR only, with token information). In non-quick comparison mode, either <strong id="drs_03_0136__b752416471434">compare_object_infos</strong> or <strong id="drs_03_0136__b752624719435">compare_object_infos_with_token</strong> must be specified based on the migration scenario.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0136__table149434955816"></a><a name="table149434955816"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table149434955816" frame="border" border="1" rules="all"><caption><b>Table 5 </b>CompareObjectInfo</caption><thead align="left"><tr id="drs_03_0136__row13834173115527"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="drs_03_0136__p1583463125215">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_0136__p18834531135212">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_0136__p18835153195212">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_0136__p0835183112523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row15834143113529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0136__p128351831115220">db_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0136__p1083553117520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0136__p183514316521">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0136__p178351231125213">Database name.</p>
</td>
</tr>
<tr id="drs_03_0136__row68341131175212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0136__p1983553195210">table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0136__p118368311526">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0136__p283663112522">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0136__p983653110528">List of table names in the database.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0136__table199441591587"></a><a name="table199441591587"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table199441591587" frame="border" border="1" rules="all"><caption><b>Table 6 </b>CompareObjectInfoWithToken</caption><thead align="left"><tr id="drs_03_0136__row1683617314528"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="drs_03_0136__p1783716317521">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_0136__p783733115212">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_0136__p1283733115216">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_0136__p2837631195215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row15836123145213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_03_0136__p15837123175213">db_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_03_0136__p12837431155217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_03_0136__p6837531175215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="drs_03_0136__p383817310526">Database name.</p>
</td>
</tr>
<tr id="drs_03_0136__row183663155217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_03_0136__p148386318521">table_name_with_token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_03_0136__p78381731125210">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_03_0136__p158387317523">Array of <a href="#drs_03_0136__table294414935816">CompareTableInfoWithToken</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="drs_03_0136__p783873145211">List of tables (with tokens) in the database.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0136__table294414935816"></a><a name="table294414935816"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table294414935816" frame="border" border="1" rules="all"><caption><b>Table 7 </b>CompareTableInfoWithToken</caption><thead align="left"><tr id="drs_03_0136__row78381531105214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.1"><p id="drs_03_0136__p1483963105210">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.2"><p id="drs_03_0136__p12839163119527">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_0136__p1283993110527">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_0136__p16839531155210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row12838143114520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0136__p108391631105211">table_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0136__p148401231185214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0136__p1484053116527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0136__p78401031145216">Table name</p>
</td>
</tr>
<tr id="drs_03_0136__row4838103117528"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0136__p0840173175217">min_token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0136__p18401231195210">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0136__p1084043115220">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0136__p7840123110520">Min token of a table.</p>
</td>
</tr>
<tr id="drs_03_0136__row28391431155218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_03_0136__p884143115219">max_token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_03_0136__p1841153195212">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_03_0136__p168411231185212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_03_0136__p1284115314525">Max token of a table.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0136__section208411631165216"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0136__p2841431115219"><strong id="drs_03_0136__b1984123111529">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table125591241105914" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0136__row1884263114528"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_03_0136__p984218313527">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_0136__p4842153195212">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_0136__p10842173116527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row1384218315529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0136__p20843173185219">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0136__p384316316526">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0136__p48431831185216">Task ID</p>
</td>
</tr>
<tr id="drs_03_0136__row6842231185217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0136__p17843163155215">object_level_compare_create_result</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0136__p38431431135216"><a href="#drs_03_0136__table16560841155911">CreateCompareTaskResult</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0136__p1184393117522">Result of creating an object-level comparison task.</p>
</td>
</tr>
<tr id="drs_03_0136__row1184217310527"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0136__p108431831185218">data_level_compare_create_result</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0136__p108441314521"><a href="#drs_03_0136__table16560841155911">CreateCompareTaskResult</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0136__p3844183115528">Result of creating a data-level comparison task.</p>
</td>
</tr>
<tr id="drs_03_0136__row20842183118521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0136__p1284410312528">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0136__p1844731105215">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0136__p128441431145211">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0136__row16842931125210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0136__p188441319525">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0136__p11844193115213">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0136__p1984413115528">Error message, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0136__table16560841155911"></a><a name="table16560841155911"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__table16560841155911" frame="border" border="1" rules="all"><caption><b>Table 9 </b>CreateCompareTaskResult</caption><thead align="left"><tr id="drs_03_0136__row8845631175216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_03_0136__p9845113119528">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_0136__p3845103112527">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_0136__p208461231165219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row2845431175213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0136__p1784623117524">compare_task_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0136__p1984693105219">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0136__p284733112529">After the comparison task is created, the ID of the comparison task is returned for querying the result of the comparison task.</p>
</td>
</tr>
<tr id="drs_03_0136__row48451731185217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0136__p17847163115219">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0136__p13847631185217">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0136__p2848173116528">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0136__row1384593120521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0136__p1784823135214">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0136__p7848153165214">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0136__p1484843135210">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_0136__section10164510105613"><h4 class="sectiontitle">Example Request</h4><p id="drs_03_0136__p71656107562">Example of creating a comparison task:</p>
<pre class="screen" id="drs_03_0136__screen132719188537">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/create-compare-task</pre>
<pre class="screen" id="drs_03_0136__screen132601429125315">{
"job_id" : "94800607-3cd8-4f7d-a340-63a10f8jb502",
"object_level_compare_type" : "objects",
"data_level_compare_info" : {
"conflict_policy" : "keep",
"compare_type" : "contents",
"compare_mode" : null,
"start_time" : null,
"compare_object_infos" : [ {
"db_name" : "may_5",
"table_name" : [ "table_name_0", "table_name_1" ]
} ]
}
}</pre>
</div>
<div class="section" id="drs_03_0136__section1539261025612"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0136__p20392141016567"><strong id="drs_03_0136__b339231075612">Status code: 200</strong></p>
<p id="drs_03_0136__p6392191065615">OK</p>
<pre class="screen" id="drs_03_0136__screen79521131105211">{
"job_id" : "94800607-3cd8-4f7d-a340-63a10f8jb502",
"object_level_compare_create_result" : {
"compare_task_id" : "dc1683d9-bdf2-4be9-967f-6ef0953369bc"
},
"data_level_compare_create_result" : {
"compare_task_id" : "08cad1f8-9de2-42fa-b8ce-6c36daf730f6"
}
}</pre>
</div>
<div class="section" id="drs_03_0136__section12393191016569"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0136__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0136__row316919105568"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="drs_03_0136__p12393121075620">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="drs_03_0136__p1239318106563">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0136__row61691810155613"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0136__p439320101565">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0136__p1139341035614">OK</p>
</td>
</tr>
<tr id="drs_03_0136__row16169410105614"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0136__p63931510105610">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0136__p123935107561">Bad Request</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0136__section203937106566"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0136__p13393110155610">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