forked from laiweijian4/doc-exports
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>
449 lines
32 KiB
HTML
449 lines
32 KiB
HTML
<a name="drs_api_0103"></a><a name="drs_api_0103"></a>
|
|
|
|
<h1 class="topictitle1">Processing Data in Batches</h1>
|
|
<div id="body162741959144613"><div class="section" id="drs_api_0103__section1227412594463"><h4 class="sectiontitle">Function</h4><p id="drs_api_0103__p162761059164619">This API is used to add rules for data processing.</p>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section162778599465"><h4 class="sectiontitle">Constraints</h4><ul id="drs_api_0103__ul427855916465"><li id="drs_api_0103__li927818599461">Each table has only one verification rule.</li><li id="drs_api_0103__li112791559134612">MySQL source database supports a maximum of 10,000 tables at a time.</li><li id="drs_api_0103__li1928015595465">The filter criteria do not support the package, function, variable, and constant that are unique to a certain database engine. You must use standardized SQL.</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section162828591468"><h4 class="sectiontitle">URI</h4><p id="drs_api_0103__p828375911462">POST /v3/{project_id}/jobs/batch-transformation</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__table928605918467" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_api_0103__row1928415918461"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_api_0103__p928725912466">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_0103__p72885594462">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_0103__p7289059104612">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_0103__p82901459124619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row1728415599463"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_api_0103__p429195974617">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_api_0103__p129210597460">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_api_0103__p7294159174617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_api_0103__p129535911466">Project ID of a tenant in a region</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section1229718597466"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_api_0103__row1629955914616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_api_0103__p7301145984612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="drs_api_0103__p16302659174618">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="drs_api_0103__p33031959104615">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="drs_api_0103__p13304185944618">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row02991259204610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_api_0103__p530511594469">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_api_0103__p3307115904615">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_api_0103__p1530815918460">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_api_0103__p899411511316">The content type.</p>
|
|
<p id="drs_api_0103__p123256415450">The default value is <strong id="drs_api_0103__b11960161841318">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row1729917593467"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_api_0103__p1631155934617">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_api_0103__p1131211596462">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_api_0103__p113134594467">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_api_0103__p331565910463">User token obtained from IAM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row1429905910464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_api_0103__p1631613594468">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_api_0103__p1531813592467">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_api_0103__p631965913462">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_api_0103__p832018596464">Request language type</p>
|
|
<p id="drs_api_0103__p68691956125917">Default value: <strong id="drs_api_0103__b1786912566599">en-us</strong></p>
|
|
<p id="drs_api_0103__p1386915625912">Values:</p>
|
|
<ul id="drs_api_0103__ul1586965613591"><li id="drs_api_0103__li1886915655910"><strong id="drs_api_0103__b158691656145912">en-us</strong></li><li id="drs_api_0103__li17869125685916"><strong id="drs_api_0103__b12869175615914">zh-cn</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_api_0103__row20322145954617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_api_0103__p17324759144618">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="drs_api_0103__p17326195984610">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="drs_api_0103__p232716596461">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="drs_api_0103__p0329145916461">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row13322195964616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_api_0103__p63303592461">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_api_0103__p9331195919461">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_api_0103__p1433285924618">Array of <a href="#drs_api_0103__request_CheckDataTransformationReq">CheckDataTransformationReq</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_api_0103__p11333195913469">Requests for adding data processing rules in batches.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_api_0103__request_CheckDataTransformationReq"></a><a name="request_CheckDataTransformationReq"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__request_CheckDataTransformationReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>CheckDataTransformationReq</caption><thead align="left"><tr id="drs_api_0103__row13341859164616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="drs_api_0103__p13336165914611">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="drs_api_0103__p73372596462">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="drs_api_0103__p0338859124617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="drs_api_0103__p1339159134611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row20334155964610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_api_0103__p03401459144619">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_api_0103__p13342159144618">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_api_0103__p123431659134615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_api_0103__p103441559124615">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row6334959194615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_api_0103__p5345145924610">object_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_api_0103__p8346559194611">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_api_0103__p11348559124615">Array of <a href="#drs_api_0103__request_DatabaseObjectVO">DatabaseObjectVO</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_api_0103__p1534965914610">Object information. This parameter is mandatory when a processing rule is generated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row1133565914619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_api_0103__p14350185954619">transformation_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_api_0103__p9351135954611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_api_0103__p9353115974612"><a href="#drs_api_0103__request_TransformationInfo">TransformationInfo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_api_0103__p103541159184618">Processing information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row20335459104615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_api_0103__p193557594460">config_transformation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_api_0103__p14356105924617">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_api_0103__p11357155914465"><a href="#drs_api_0103__request_ConfigTransformationVo">ConfigTransformationVo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><ul id="drs_api_0103__ul1935985911469"><li id="drs_api_0103__li6360185944612">Configuration information. If there are multiple associated tables, generate multiple configuration rules. The data that meets the configuration conditions is temporarily stored in the cache and used in the data filtering scenario.</li><li id="drs_api_0103__li9362105974610">The database name and table name can contain digits, letters, and underscores (_).</li><li id="drs_api_0103__li33641459164616">Ensure that the column names, primary keys, and indexes are the same as those in the source database.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_api_0103__request_DatabaseObjectVO"></a><a name="request_DatabaseObjectVO"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__request_DatabaseObjectVO" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DatabaseObjectVO</caption><thead align="left"><tr id="drs_api_0103__row2036645944619"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.1"><p id="drs_api_0103__p15369195924617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.2"><p id="drs_api_0103__p1737015591467">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.5.1.3"><p id="drs_api_0103__p163712599462">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.5.2.5.1.4"><p id="drs_api_0103__p1837235964611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row6366185994610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_api_0103__p12373135914460">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_api_0103__p3374559194612">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_api_0103__p14375659104618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_api_0103__p163771659134613">Database name and database table name. For example, the format is <strong id="drs_api_0103__b848014379210">lxl_test1-*-*-test_1</strong>, where <strong id="drs_api_0103__b537913421526">lxl_test1</strong> is the database name and <strong id="drs_api_0103__b18332154715210">test_1</strong> is the table name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row836619592466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_api_0103__p137815597469">select</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_api_0103__p1738045954613">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_api_0103__p738135984616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_api_0103__p238285919463">Whether to select advanced configuration. The value is <strong id="drs_api_0103__b1551378319111136">true</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row190011523523"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_api_0103__p2901165219522">leavesNum</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_api_0103__p119011152185218">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_api_0103__p728437145416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_api_0103__p5901135213527">Level of a processing object. The default value is <strong id="drs_api_0103__b533932512119">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_api_0103__request_TransformationInfo"></a><a name="request_TransformationInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__request_TransformationInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>TransformationInfo</caption><thead align="left"><tr id="drs_api_0103__row838319596469"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.1"><p id="drs_api_0103__p438510597463">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.2"><p id="drs_api_0103__p53861259154616">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.5.1.3"><p id="drs_api_0103__p5387115913462">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.6.2.5.1.4"><p id="drs_api_0103__p10388659204617">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row738325920464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_api_0103__p11389059144618">transformation_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_api_0103__p439065944618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_api_0103__p1239215914615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><ul id="drs_api_0103__ul339325916461"><li id="drs_api_0103__li3393125913464">The processing rule value is <strong id="drs_api_0103__b563661802111136">contentConditionalFilter</strong>.</li><li id="drs_api_0103__li14394459164612">The configuration rule value is <strong id="drs_api_0103__b62251526111136">configConditionalFilter</strong>.<p id="drs_api_0103__p1574153212526">Values:</p>
|
|
<ul id="drs_api_0103__ul05741032175211"><li id="drs_api_0103__li4574123205215"><strong id="drs_api_0103__b1957413323527">contentConditionalFilter</strong></li><li id="drs_api_0103__li15574103225215"><strong id="drs_api_0103__b757443210524">configConditionalFilter</strong></li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row20383155924615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.1 "><p id="drs_api_0103__p1139518597460">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.2 "><p id="drs_api_0103__p183973595468">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.5.1.3 "><p id="drs_api_0103__p239825917461">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.6.2.5.1.4 "><p id="drs_api_0103__p13991259104619">Filter criteria. The processing rule value is a SQL statement, and the configuration rule value is <strong id="drs_api_0103__b951107726111136">config</strong>. The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_api_0103__request_ConfigTransformationVo"></a><a name="request_ConfigTransformationVo"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__request_ConfigTransformationVo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ConfigTransformationVo</caption><thead align="left"><tr id="drs_api_0103__row74011259144614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.1"><p id="drs_api_0103__p104041859204617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.2"><p id="drs_api_0103__p1440555994611">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.5.1.3"><p id="drs_api_0103__p6405559114616">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.7.2.5.1.4"><p id="drs_api_0103__p240785944611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row1440116596461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p1640855914463">db_table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p340935911469">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p174101759204616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p8413195917468"><em id="drs_api_0103__i16229654848">Database-name.Table-name</em>, for example, <strong id="drs_api_0103__b169591517412">lxl_test1.test_1</strong>, where <strong id="drs_api_0103__b1747119230412">lxl_test1</strong> is the database name and <strong id="drs_api_0103__b541317281242">test_1</strong> is the table name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row64018599467"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p0414105911468">db_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p16415115964614">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p841645910460">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p641718598464">Database name. The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row2401145910466"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p20418659134620">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p1041975920464">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p194211359114614">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p1542310596462">Table name The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row440175944619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p14251459164611">col_names</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p1942995911468">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p184306593463">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p10431185912461">Column name The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row74011259134615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p184324591467">prim_key_or_index</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p4433195904614">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p4434105914610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p14435165917461">Primary key or unique index The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row64021059124610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p9436125915468">indexs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p4437559114610">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p184411359154613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p15444359104611">Index that requires optimization. The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row94021359194612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.1 "><p id="drs_api_0103__p1445155934614">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.2 "><p id="drs_api_0103__p0446155910463">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.5.1.3 "><p id="drs_api_0103__p34481559154611">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.7.2.5.1.4 "><p id="drs_api_0103__p1244910597461">Filtering criteria. The value contains a maximum of 256 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section24491593466"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_api_0103__p194511959144618"><strong id="drs_api_0103__b045145913465">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="drs_api_0103__row4452135944617"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_api_0103__p12455155944614">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="drs_api_0103__p144571759134617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="drs_api_0103__p1845914596464">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row124521659144620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_api_0103__p164621259204613">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_api_0103__p54641159154619">Array of <a href="#drs_api_0103__response_DataTransformationResp">DataTransformationResp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_api_0103__p146575912462">Batch data processing response list.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row1245205964620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_api_0103__p13468205984614">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_api_0103__p1046985924618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_api_0103__p2047165913468">Total number.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_api_0103__response_DataTransformationResp"></a><a name="response_DataTransformationResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__response_DataTransformationResp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>DataTransformationResp</caption><thead align="left"><tr id="drs_api_0103__row154731359184611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_api_0103__p18477135974618">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="drs_api_0103__p547810593460">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="drs_api_0103__p04791959144619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row947319590462"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_api_0103__p15480959204610">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_api_0103__p174822598464">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_api_0103__p14831559134618">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row1473155994614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_api_0103__p648455916461">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_api_0103__p148655913463">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_api_0103__p12487135974618">Status Values:</p>
|
|
<ul id="drs_api_0103__ul649011594463"><li id="drs_api_0103__li124901159154616"><strong id="drs_api_0103__b14911759174614">success</strong></li><li id="drs_api_0103__li1849115934614"><strong id="drs_api_0103__b449265954616">failed</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row114735596464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_api_0103__p94931659104618">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_api_0103__p5494059104616">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_api_0103__p34951659144619">Error code, which is optional and indicates the returned information about the failure status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row184734594469"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_api_0103__p8496155919460">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_api_0103__p1498195912466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_api_0103__p164996592464">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_api_0103__section750075917469"><h4 class="sectiontitle">Example Request</h4><ul id="drs_api_0103__ul5502165914469"><li id="drs_api_0103__li16502659154610">Example of MySQL data generation configuration rules:<pre class="screen" id="drs_api_0103__screen114419575451">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-transformation</pre>
|
|
<pre class="screen" id="drs_api_0103__screen36949420466">{
|
|
"jobs" : [ {
|
|
"job_id" : "e894593d-5e0a-4652-af7e-1b0c239jb201",
|
|
"object_info" : [ ],
|
|
"transformation_info" : {
|
|
"transformation_type" : "configConditionalFilter",
|
|
"value" : "config"
|
|
},
|
|
"config_transformation" : {
|
|
"col_names" : "id,name",
|
|
"db_name" : "lxl_test1",
|
|
"db_table_name" : "lxl_test1.test_1",
|
|
"indexs" : "name",
|
|
"prim_key_or_index" : "id",
|
|
"table_name" : "test_1",
|
|
"values" : "name like '%a%'"
|
|
}
|
|
} ]
|
|
}</pre>
|
|
</li><li id="drs_api_0103__li1452745913467">Example of MySQL data generation and processing rules:<pre class="screen" id="drs_api_0103__screen769463554611">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-transformation</pre>
|
|
<pre class="screen" id="drs_api_0103__screen190714714476">{
|
|
"jobs" : [ {
|
|
"job_id" : "e894593d-5e0a-4652-af7e-1b0c239jb201",
|
|
"object_info" : [ {
|
|
"id" : "lxl_test1-*-*-test_1",
|
|
"select" : "true"
|
|
} ],
|
|
"transformation_info" : {
|
|
"transformation_type" : "contentConditionalFilter",
|
|
"value" : "id>5"
|
|
}
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section185005954611"><h4 class="sectiontitle">Example Response</h4><p id="drs_api_0103__p188511459104614"><strong id="drs_api_0103__b1385119590467">Status code: 200</strong></p>
|
|
<p id="drs_api_0103__p10851359144612">OK</p>
|
|
<pre class="screen" id="drs_api_0103__screen2852105934611">{
|
|
"count" : 1,
|
|
"results" : [ {
|
|
"id" : "e894593d-5e0a-4652-af7e-1b0c239jb201",
|
|
"status" : "success"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section1854175904615"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_api_0103__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_api_0103__row155118596460"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="drs_api_0103__p5855459144611">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_api_0103__p485505918466">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_api_0103__row655145919469"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_api_0103__p13855185974613">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_api_0103__p1885635912469">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_api_0103__row755112599461"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_api_0103__p9856155924613">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_api_0103__p2856175915467">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_api_0103__section185735913469"><h4 class="sectiontitle">Error Code</h4><p id="drs_api_0103__p1285815917464">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_api_0100.html">Real-Time Synchronization Management</a></div>
|
|
</div>
|
|
</div>
|
|
|