forked from docs/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>
643 lines
34 KiB
HTML
643 lines
34 KiB
HTML
<a name="drs_03_0111"></a><a name="drs_03_0111"></a>
|
|
|
|
<h1 class="topictitle1">Querying Pre-check Results in Batches</h1>
|
|
<div id="body18951824165013"><div class="section" id="drs_03_0111__section19951324165016"><h4 class="sectiontitle">Function</h4><p id="drs_03_0111__p159510249507">This API is used to query the pre-check results of tasks in batches.</p>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section174028414452"><h4 class="sectiontitle">Constraints</h4><ul id="drs_03_0111__ul021333141215"><li id="drs_03_0111__li62233141214">This API can be called only when the task status is <strong id="drs_03_0111__b1642881520298">CONFIGURATION</strong> and the pre-check API is invoked.</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section1895142411504"><h4 class="sectiontitle">URI</h4><p id="drs_03_0111__p0952024205016">POST /v3/{project_id}/jobs/batch-precheck-result</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__table1995362417504" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0111__row16952824185011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0111__p1995332465016">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_0111__p7953112417507">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_0111__p159541824105019">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_0111__p15954424135018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row1995292485013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0111__p6954122412502">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0111__p49541824125013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0111__p5954172445013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0111__p895519244502">Project ID of a tenant in a region</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section29558240501"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0111__row1495510246508"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_03_0111__p895622412506">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_0111__p17956102435013">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_0111__p895672412504">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_0111__p59567245500">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row119552024155011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0111__p1995713242500">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0111__p1595762455016">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0111__p295722416505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0111__p321115651911">The content type.</p>
|
|
<p id="drs_03_0111__p123256415450">The default value is <strong id="drs_03_0111__b1230810191914">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row1795562414508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0111__p89571624175010">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_0111__p595722495013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0111__p16958724115011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0111__p195852445015">User token obtained from IAM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row99551124185014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0111__p795817246504">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0111__p29581124145013">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0111__p1695832455013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0111__p4869125616598">Request language type</p>
|
|
<p id="drs_03_0111__p68691956125917">Default value: <strong id="drs_03_0111__b1786912566599">en-us</strong></p>
|
|
<p id="drs_03_0111__p1386915625912">Values:</p>
|
|
<ul id="drs_03_0111__ul1586965613591"><li id="drs_03_0111__li1886915655910"><strong id="drs_03_0111__b158691656145912">en-us</strong></li><li id="drs_03_0111__li17869125685916"><strong id="drs_03_0111__b12869175615914">zh-cn</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0111__row69595246504"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_03_0111__p1396032419505">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_0111__p1960824135012">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_0111__p4960172419503">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_0111__p109601324145018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row6959162475017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0111__p49601424165019">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0111__p096172412506">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0111__p2961182418503">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0111__p396119245504">Request for querying pre-check results in batches. The value cannot be empty. The values must comply with the UUID rule. The task ID must be unique.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section69613245503"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0111__p19962192425010"><strong id="drs_03_0111__b9962122413503">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0111__row496912465013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_03_0111__p11970112418504">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_0111__p9970172416501">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_0111__p19970624145019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row9969724105016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0111__p12970192435019">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0111__p1197011245508">Array of <a href="#drs_03_0111__response_QueryPreCheckResp">QueryPreCheckResp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0111__p4971024145015">Response body set for querying pre-check results in batches.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row1996982412501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0111__p1897111246509">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0111__p1597112247509">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0111__p4971142495018">Total number of records.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0111__response_QueryPreCheckResp"></a><a name="response_QueryPreCheckResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__response_QueryPreCheckResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>QueryPreCheckResp</caption><thead align="left"><tr id="drs_03_0111__row5972124205018"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_03_0111__p797315242502">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_0111__p10973112418504">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_0111__p4973124165012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row2972724175017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p109739248504">precheck_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p14973182415502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p109737246505">ID of the task for querying the pre-check result.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row29721624195017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p9974162405020">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p13974182435010">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p2097432415508">Whether the pre-check items are passed. <strong id="drs_03_0111__b29855265881721">true</strong>: indicates that the pre-check is passed. The task can be started only after the pre-check is passed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row1597282445012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p6974202485010">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p4974112455013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p097472465011">Pre-check progress, in percentage.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row597216241504"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p8975624145017">total_passed_rate</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p10975424105013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p139751824165017">Percentage of passed pre-checks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row897262414500"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p1097510248503">rds_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p497502435012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p79754243503">RDS DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row39721324135016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p297613246505">job_direction</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p1197612413502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p11976112465011">Task direction. Values:</p>
|
|
<ul id="drs_03_0111__ul169761024185010"><li id="drs_03_0111__li69765242503"><strong id="drs_03_0111__b51707324269">up</strong>: to-the-cloud scenarios and the current cloud is the standby cloud in the DR.</li><li id="drs_03_0111__li11976172445018"><strong id="drs_03_0111__b15250173622610">down</strong>: out-of-cloud scenarios and the current cloud is the active cloud in the DR.</li><li id="drs_03_0111__li697672445016"><strong id="drs_03_0111__b1869194522013">non-dbs</strong>: self-built databases.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row79729245501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p89773240504">precheck_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p109771242508">Array of <a href="#drs_03_0111__response_PrecheckResult">PrecheckResult</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p597712435018">Pre-check results.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row69721524165013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p9978142415503">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p897802435011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p1697814242507">Error message, which is optional and indicates the returned information about the failure status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row3972152417504"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0111__p19978142455012">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0111__p17978122413509">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0111__p4978162435016">Error code, 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_0111__response_PrecheckResult"></a><a name="response_PrecheckResult"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__response_PrecheckResult" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PrecheckResult</caption><thead align="left"><tr id="drs_03_0111__row897982411506"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="drs_03_0111__p1998017245507">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="drs_03_0111__p298012418509">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="drs_03_0111__p19980162412502">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row189791624175015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p998017241501">item</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p1398018248507">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p20980182445017">Check item.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row4979162418507"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p10981182414507">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p99811824105018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p498132418508">Check results. Values:</p>
|
|
<ul id="drs_03_0111__ul1998172425017"><li id="drs_03_0111__li1198172410504"><strong id="drs_03_0111__b1998115246501">PASSED</strong></li><li id="drs_03_0111__li1298118249501"><strong id="drs_03_0111__b198119246507">ALARM</strong></li><li id="drs_03_0111__li798212246507"><strong id="drs_03_0111__b1498212445013">FAILED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row5979182425019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p1398252445014">failed_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p1398222455018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p59821924135010">Failure cause.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row8979102417509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p109821624105017">data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p1998219249505">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p1598315244507">Encrypted data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row16979142475010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p1698311246504">raw_error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p10983102475012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p16983112418507">Row error message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row1497992415014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p1598322485016">group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p798412249501">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p7984924165011">Check item group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row16979182495011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="drs_03_0111__p14984142465018">failed_sub_jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="drs_03_0111__p18984924175014">Array of <a href="#drs_03_0111__response_PrecheckFailSubJobVO">PrecheckFailSubJobVO</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="drs_03_0111__p698411249505">Information about failed subtasks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="drs_03_0111__response_PrecheckFailSubJobVO"></a><a name="response_PrecheckFailSubJobVO"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__response_PrecheckFailSubJobVO" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PrecheckFailSubJobVO</caption><thead align="left"><tr id="drs_03_0111__row1398582417509"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.1"><p id="drs_03_0111__p14985924205019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.6.2.4.1.2"><p id="drs_03_0111__p198518249504">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.6.2.4.1.3"><p id="drs_03_0111__p8986024165015">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row898513247501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="drs_03_0111__p798662420507">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="drs_03_0111__p4986182410501">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="drs_03_0111__p8986112465019">ID of the subtask that fails to pass the pre-check.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row99858244506"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="drs_03_0111__p1198662465012">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="drs_03_0111__p1498713247507">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="drs_03_0111__p109874243502">The name of the subtask that fails to pass the pre-check.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row1985142425011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.1 "><p id="drs_03_0111__p1598717241504">check_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.6.2.4.1.2 "><p id="drs_03_0111__p298782410502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.6.2.4.1.3 "><p id="drs_03_0111__p1698712249503">Check results.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section598752405012"><h4 class="sectiontitle">Example Request</h4><ul id="drs_03_0111__ul598822445013"><li id="drs_03_0111__li59880249502">Query the pre-check results of the DDS database real-time migration.<pre class="screen" id="drs_03_0111__screen14512143135314">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-precheck-result</pre>
|
|
<pre class="screen" id="drs_03_0111__screen397518920538">{
|
|
"jobs" : [ "a281f62f-4631-45d6-a2d3-679a9f4jb105" ]
|
|
}</pre>
|
|
</li><li id="drs_03_0111__li898932485011">Query the pre-check results of the MySQL database real-time migration.<pre class="screen" id="drs_03_0111__screen1221710328535">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-precheck-result</pre>
|
|
<pre class="screen" id="drs_03_0111__screen206032042105319">{
|
|
"jobs" : [ "140b5236-88ad-43c8-811c-1268453jb101" ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section09899244503"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0111__p7990112416507"><strong id="drs_03_0111__b9990224145012">Status code: 200</strong></p>
|
|
<p id="drs_03_0111__p20990122416503">OK</p>
|
|
<ul id="drs_03_0111__ul1599002405012"><li id="drs_03_0111__li1899062416503">Example response for querying the pre-check result during real-time MySQL migration:<pre class="screen" id="drs_03_0111__screen79931724165019">{
|
|
"count" : 1,
|
|
"results" : [ {
|
|
"result" : true,
|
|
"process" : "100%",
|
|
"precheck_id" : "140b5236-88ad-43c8-811c-1268453jb101",
|
|
"total_passed_rate" : "100%",
|
|
"rds_instance_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
|
|
"job_direction" : "up",
|
|
"precheck_result" : [ {
|
|
"item" : "dstDbDiskSize",
|
|
"result" : "PASSED",
|
|
"data" : "{\"diskSizeTimes\":\"1.5\",\"dstVolumeSize\":\"37660000000\",\"srcIndexSize\":0,\"size\":\"0\",\"srcIndexAmount\":0}",
|
|
"group" : "db_disk_size"
|
|
}, {
|
|
"item" : "checkIncreSrcDbExistedInDstDb",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbCharacterSetConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbClockConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbCollationServerConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbIsolationLevelConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbParamConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dbServerUuidConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dstMaxAllowedPacketCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "hasForeignKeyOnUnselectedTable",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "innodbStrictModeConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "isUserRequireSslLink",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "sqlModeConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "sqlModeNoEngine",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcBinlogFormatCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcBinlogRowImageCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbBinlogExpireLogsDays",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbBinlogIsOff",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbExistUnsupportEngineTable",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbIndexKeyLength",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbNameContainsUnsupportedSymbols",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbServerIdCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDstTableNameCaseSensitiveCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcHasNoPkTableWhenTgtHasInvisiblePk",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcRoutinesWithoutPrivilegeCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcTableNameContainsNonAscii",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcTriggerAndEventCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcViewNameContainsNonAscii",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srclogSlaveUpdatesCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "userRequirementIsEnoughForDefiner",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "userSelectObjectsCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dstStatusCheck",
|
|
"result" : "PASSED",
|
|
"data" : "",
|
|
"group" : "db_target_status",
|
|
"failed_reason" : ""
|
|
}, {
|
|
"item" : "dstDbPrivilegesIsEnough",
|
|
"result" : "PASSED",
|
|
"group" : "db_user_privilege"
|
|
}, {
|
|
"item" : "srcDbPrivilegesIsEnoughForIncre",
|
|
"result" : "PASSED",
|
|
"group" : "db_user_privilege"
|
|
}, {
|
|
"item" : "dbVersionMeetRequirement",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "dstDbVersionSupport",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "srcDbVersionSupport",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "dstDbConnection",
|
|
"result" : "PASSED",
|
|
"group" : "network"
|
|
}, {
|
|
"item" : "srcDbConnection",
|
|
"result" : "PASSED",
|
|
"group" : "network"
|
|
} ]
|
|
} ]
|
|
}</pre>
|
|
</li><li id="drs_03_0111__li6364172525018">Example response for querying the pre-check result during real-time DDS migration:<pre class="screen" id="drs_03_0111__screen1436402585016">{
|
|
"count" : 1,
|
|
"results" : [ {
|
|
"result" : true,
|
|
"process" : "100%",
|
|
"precheck_id" : "a281f62f-4631-45d6-a2d3-679a9f4jb105",
|
|
"total_passed_rate" : "100%",
|
|
"rds_instance_id" : "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02",
|
|
"job_direction" : "up",
|
|
"precheck_result" : [ {
|
|
"item" : "dstDbDiskSize",
|
|
"result" : "PASSED",
|
|
"data" : "{'size': '5263360', 'dstVolumeSize':'19089431762', 'diskSizeTimes':'1.5'}",
|
|
"group" : "db_disk_size"
|
|
}, {
|
|
"item" : "srcAndDstCappedCollConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_object_conflict_check"
|
|
}, {
|
|
"item" : "srcCollAlreadyExistedInDstColl",
|
|
"result" : "PASSED",
|
|
"group" : "db_object_conflict_check"
|
|
}, {
|
|
"item" : "srcViewAlreadyExistedInDstView",
|
|
"result" : "PASSED",
|
|
"group" : "db_object_conflict_check"
|
|
}, {
|
|
"item" : "rolesDependentCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_object_dependency_check"
|
|
}, {
|
|
"item" : "usersDependentCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_object_dependency_check"
|
|
}, {
|
|
"item" : "srcCollHasTtlIndex",
|
|
"result" : "ALARM",
|
|
"data" : "{\"srcHasTtlIndexColls\":\"fastunit.ttlsuoyin\"}",
|
|
"group" : "db_params",
|
|
"failed_reason" : "SRC_HAS_TTL_INDEXES"
|
|
}, {
|
|
"item" : "dbSslConsistency",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dstChunkNumCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "mongoTypeFitTransferMode",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcCollIndexNumCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcCollNameContainsUnsupportedSymbols",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbInstanceIsEmpty",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcDbNameContainsUnsupportedSymbols",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "srcIdIndexCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "userSelectObjectsCheck",
|
|
"result" : "PASSED",
|
|
"group" : "db_params"
|
|
}, {
|
|
"item" : "dstStatusCheck",
|
|
"result" : "PASSED",
|
|
"data" : "",
|
|
"group" : "db_target_status",
|
|
"failed_reason" : ""
|
|
}, {
|
|
"item" : "dstDbPrivilegesIsEnough",
|
|
"result" : "PASSED",
|
|
"group" : "db_user_privilege"
|
|
}, {
|
|
"item" : "srcDbPrivilegesIsEnough",
|
|
"result" : "PASSED",
|
|
"group" : "db_user_privilege"
|
|
}, {
|
|
"item" : "dbVersionMeetRequirement",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "dstDbVersionSupport",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "srcDbVersionSupport",
|
|
"result" : "PASSED",
|
|
"group" : "db_version"
|
|
}, {
|
|
"item" : "dstDbConnection",
|
|
"result" : "PASSED",
|
|
"group" : "network"
|
|
}, {
|
|
"item" : "srcDbConnection",
|
|
"result" : "PASSED",
|
|
"group" : "network"
|
|
}, {
|
|
"item" : "srcShardKeyConfiguration",
|
|
"result" : "ALARM",
|
|
"data" : "{\"notConfigShardIndexColls\":\"ycsb.usertable,mgo.mycollection7,mgo.mycollection9,mgo.mycollection5,mgo.mycollection4,mgo.mycollection3,mgo.mycollection,mgo.mycollection8,mgo.mycollection2,mgo.mycollection6,testdb3.testuk,testdb3.coll2,testdb3.coll6,testdb3.coll1,testdb3.Coll1,testdb3.testuk2,testdb3.coll5,testdb3.coll4,testdb1.coll6,testdb1.coll1,testdb1.testuk2,testdb1.coll2,testdb1.testuk,testdb1.coll5,testdb1.coll4,testdb1.Coll1,Testdb5.coll1,Testdb5.collx,Testdb5.Coll1,fastunit.gudingjihe,fastunit.geohaystack,fastunit.coll,fastunit.weiyisuoyin,fastunit.testSpecial\\\\u4E2D\\\\u6587~!@#%^&*()_+=-[]{};:?,`,fastunit.log,fastunit.twoD,fastunit.lianhesuoyin,fastunit.xishusuoyin,fastunit.quanwensuoyin,fastunit.ttlsuoyin,fastunit.putongsuoyin,fastunit.collcount,fastunit.shuzusuoyin,fastunit.twodsphere,fastunit.qiantaowendangsuoyin,fastunit.indexpartial\"}",
|
|
"group" : "src_info_check",
|
|
"failed_reason" : "SRC_INSTANCE_TYPE_IS_REPLICA_SET"
|
|
}, {
|
|
"item" : "checkBalanceStatus",
|
|
"result" : "PASSED",
|
|
"group" : "src_info_check"
|
|
}, {
|
|
"item" : "srcMongoInstanceType",
|
|
"result" : "PASSED",
|
|
"group" : "src_info_check"
|
|
} ]
|
|
} ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section037152512506"><h4 class="sectiontitle">Status Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0111__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0111__row102492519508"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="drs_03_0111__p337119251509">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_0111__p1637117251504">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="drs_03_0111__row182482515015"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0111__p6371425125012">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0111__p4371825195019">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="drs_03_0111__row824725115016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0111__p1037117257509">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0111__p11371152514508">Bad Request</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="drs_03_0111__section1437111258502"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0111__p237116255509">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>
|
|
|