vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/drs/api-ref/drs_03_0105.html
Ru, Li Yi 9c5f69ed88 drs_api_20240415 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-04-22 18:20:28 +00:00

457 lines
32 KiB
HTML
Raw Blame History

<a name="drs_03_0105"></a><a name="drs_03_0105"></a>
<h1 class="topictitle1">Testing Connections in Batches</h1>
<div id="body340220484519"><div class="section" id="drs_03_0105__section1402946458"><h4 class="sectiontitle">Function</h4><p id="drs_03_0105__p12288581078">This API is used to test the connections to the source and destination ends in batches.</p>
</div>
<div class="section" id="drs_03_0105__section174028414452"><h4 class="sectiontitle">Constraints</h4><ul id="drs_03_0105__ul021333141215"><li id="drs_03_0105__li62233141214">After the task is created, you can test the connection only when the task status is <strong id="drs_03_0105__b1721319014249">CONFIGURATION</strong>.</li><li id="drs_03_0105__li6219334129">In the dual-active DR scenario, the backward task can be executed only when the forward task is in <strong id="drs_03_0105__b1577595462516">INCRE_TRANSFER_STARTED</strong> state. The parent task cannot call the API.</li></ul>
</div>
<div class="section" id="drs_03_0105__section134028411454"><h4 class="sectiontitle">URI</h4><p id="drs_03_0105__p74021649456">POST /v3/{project_id}/jobs/batch-connection</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__table140394194512" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0105__row1840374204520"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0105__p84031244455">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_0105__p24031845453">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_0105__p9403345451">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_0105__p840419419454">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row6403174124515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0105__p940414134517">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0105__p1540411411456">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0105__p240412414452">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0105__p3404545458">Project ID of a tenant in a region</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0105__section6404174194519"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0105__row13405645458"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_03_0105__p2405134104515">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_0105__p1840574114517">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_0105__p14059417450">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_0105__p104064494516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row12405941451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0105__p140619454511">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0105__p840610454514">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0105__p1040684154519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0105__p175419561136">The content type.</p>
<p id="drs_03_0105__p123256415450">The default value is <strong id="drs_03_0105__b986011512710">application/json</strong>.</p>
</td>
</tr>
<tr id="drs_03_0105__row540513444520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0105__p8406745454">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_0105__p1740744164511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0105__p1540704154515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0105__p134075417452">User token obtained from IAM.</p>
</td>
</tr>
<tr id="drs_03_0105__row104051143452"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0105__p2040717484512">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0105__p1340714474511">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0105__p1940712464514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0105__p540704204512">Request language type</p>
<p id="drs_03_0105__p68691956125917">Default value: <strong id="drs_03_0105__b836216142718">en-us</strong></p>
<p id="drs_03_0105__p1386915625912">Values:</p>
<ul id="drs_03_0105__ul1586965613591"><li id="drs_03_0105__li1886915655910"><strong id="drs_03_0105__b158691656145912">en-us</strong></li><li id="drs_03_0105__li17869125685916"><strong id="drs_03_0105__b12869175615914">zh-cn</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0105__row840818414514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_03_0105__p74087454510">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_0105__p1740810418459">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_0105__p1740854184512">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_0105__p18409844455">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row84088444519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0105__p54099474516">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0105__p164091749456">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0105__p940924174512">Array of <a href="#drs_03_0105__request_TestEndPoint">TestEndPoint</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0105__p194091417454">List of requests for testing connections in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0105__request_TestEndPoint"></a><a name="request_TestEndPoint"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__request_TestEndPoint" frame="border" border="1" rules="all"><caption><b>Table 4 </b>TestEndPoint</caption><thead align="left"><tr id="drs_03_0105__row154101442450"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="drs_03_0105__p541124104510">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_0105__p10411124104516">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_0105__p1411144134514">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_0105__p144113416453">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row441044134518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p2412745459">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p18412164114513">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p1641211411452">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p1341214444519">DRS task ID, which can be obtained from the task list or task details page.</p>
</td>
</tr>
<tr id="drs_03_0105__row6410134124513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p11412242457">net_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p104123454520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p941313464513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p4413144174517">Network type. Value:</p>
<ul id="drs_03_0105__ul841394164516"><li id="drs_03_0105__li134138484512"><strong id="drs_03_0105__b9413144114518">vpn</strong></li><li id="drs_03_0105__li3413542454"><strong id="drs_03_0105__b12413948456">vpc</strong></li><li id="drs_03_0105__li1841324114519"><strong id="drs_03_0105__b18413142459">eip</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0105__row14410174104516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p34133474510">db_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p114143464515">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p1041444134518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p1241414144515">Database type. Value:</p>
<ul id="drs_03_0105__ul204141942453"><li id="drs_03_0105__li154141448456"><strong id="drs_03_0105__b1414204184519">mysql</strong></li><li id="drs_03_0105__li184142434518"><strong id="drs_03_0105__b44149434513">mongodb</strong></li><li id="drs_03_0105__li237125601915"><strong id="drs_03_0105__b2511926162018">taurus</strong></li><li id="drs_03_0105__li150151113289"><strong id="drs_03_0105__b277319518">postgresql</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0105__row174107410458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p114141743455">ip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p1641564174512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p6415542456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p9415146453">Database IP address.</p>
</td>
</tr>
<tr id="drs_03_0105__row18410043454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p10415141451">db_port</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p17415164154516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p17415114124511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p194161649458">Database port number. This parameter must be set to <strong id="drs_03_0105__b6392016286">0</strong> for the MongoDB and DDS databases.</p>
</td>
</tr>
<tr id="drs_03_0105__row12410447457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1541644134513">inst_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p541610474517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p7416144124511">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p1350846456">DB instance ID. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0105__row204102044454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p441610412458">db_user</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p14162047459">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p441715414450">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p841716424513">Database account.</p>
</td>
</tr>
<tr id="drs_03_0105__row841015464510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p204177464511">db_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p1741744154518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p44171414512">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p741712419454">Database password.</p>
</td>
</tr>
<tr id="drs_03_0105__row1041044104517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p114189420459">ssl_link</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p74186415452">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p2041815474519">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p2418174124520">Whether SSL is enabled. If this parameter is set to <strong id="drs_03_0105__b43021611319">true</strong>, you need to set parameters related to the SSL certificate.</p>
</td>
</tr>
<tr id="drs_03_0105__row241010415451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1441819410453">ssl_cert_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p164184414453">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p134184414458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p144191548458">SSL certificate content, which is a character string encrypted using BASE64 after the SSL certificate is obtained. This parameter is mandatory when <strong id="drs_03_0105__b1791015610318">ssl_link</strong> is set to <strong id="drs_03_0105__b1219313101138">true</strong>.</p>
</td>
</tr>
<tr id="drs_03_0105__row44101247458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1441911424513">ssl_cert_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p94197464513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p1841912424517">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p184191244456">SSL certificate name. This parameter is mandatory when <strong id="drs_03_0105__b399815381239">ssl_link</strong> is set to <strong id="drs_03_0105__b359815453319">true</strong>.</p>
</td>
</tr>
<tr id="drs_03_0105__row5410140459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1541914410451">ssl_cert_check_sum</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p19419164194514">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p14420544456">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p34201149458">The checksum value of the SSL certificate content encrypted using SHA256 after the SSL certificate is obtained, which is used for backend verification. This parameter is mandatory when <strong id="drs_03_0105__b728143713135">ssl_link</strong> is set to <strong id="drs_03_0105__b1467110397131">true</strong>.</p>
</td>
</tr>
<tr id="drs_03_0105__row441024184514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p16420145453">ssl_cert_password</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p174205454516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p24208464515">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p16420134194513">The SSL certificate password. The certificate file name extension is .p12 and requires a password.</p>
</td>
</tr>
<tr id="drs_03_0105__row13410124184515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1842119411459">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p442164164518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p942111415458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p10421164164511">ID of the VPC where the instance resides. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0105__row1941019474511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p10422154104519">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p184223414517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p04222415457">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p1942214464516">ID of the subnet where the instance resides. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0105__row19410104124511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p1442213414453">end_point_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p842244114510">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p742314104519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p12884618161610">Source database: <strong id="drs_03_0105__b114744716307">so</strong>. Destination database: <strong id="drs_03_0105__b473115156301">ta</strong>.</p>
<p id="drs_03_0105__p1873281920916">Default value: <strong id="drs_03_0105__b129851237307">so</strong></p>
<p id="drs_03_0105__p1732161910913">Values:</p>
<ul id="drs_03_0105__ul1673241915913"><li id="drs_03_0105__li973215191899"><strong id="drs_03_0105__b973215194920">so</strong></li><li id="drs_03_0105__li1773251912920"><strong id="drs_03_0105__b67323191996">ta</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0105__row17410164194519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p10423154174517">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p15423154134516">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p184244434510">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p8424184124515">Region where the DB instance is located. This parameter is mandatory when the database is a cloud instance, for example, an RDS or GaussDB(for MySQL) instance.</p>
</td>
</tr>
<tr id="drs_03_0105__row11410154174514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p8424204114519">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p342484144519">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p7424745454">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p134248494513">Project ID of the region where the user is located.</p>
</td>
</tr>
<tr id="drs_03_0105__row15411149455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0105__p124253444512">db_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0105__p442574164514">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0105__p742519413453">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0105__p24261046452">Database user name, which is the DDS authentication database.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0105__section6426641459"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0105__p742617419451"><strong id="drs_03_0105__b10272101623320">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0105__row5426104204519"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_03_0105__p84279416457">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_0105__p542854124513">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_0105__p16428124124516">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row144261646458"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0105__p1842813417457">results</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0105__p20428194134512">Array of <a href="#drs_03_0105__response_CheckJobResp">CheckJobResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0105__p84281043457">Response body set for the batch test connection.</p>
</td>
</tr>
<tr id="drs_03_0105__row124261434519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0105__p8428154144512">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0105__p242918414512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0105__p1542919434519">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0105__response_CheckJobResp"></a><a name="response_CheckJobResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__response_CheckJobResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>CheckJobResp</caption><thead align="left"><tr id="drs_03_0105__row8429124154513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_03_0105__p54304418458">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_0105__p343014419453">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_0105__p14430194184514">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row184291546457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0105__p114304414511">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0105__p184301348451">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0105__p643013419457">Task ID.</p>
</td>
</tr>
<tr id="drs_03_0105__row124291945451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0105__p1443134174517">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0105__p14432943452">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0105__p1343294174511">Test result. Value:</p>
<ul id="drs_03_0105__ul643284164510"><li id="drs_03_0105__li1243212412457"><strong id="drs_03_0105__b43875314334">success</strong>: indicates that the connection test is successful.</li><li id="drs_03_0105__li74325419454"><strong id="drs_03_0105__b97661820173519">failed</strong>: indicates that the connection test fails.</li></ul>
</td>
</tr>
<tr id="drs_03_0105__row74293434516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0105__p5432449451">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0105__p843394154510">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0105__p943324114510">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0105__row144297410453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0105__p04331445455">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0105__p3433154104513">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0105__p1343394194510">Error message, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0105__row19429743459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0105__p144339412452">success</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0105__p17434443454">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0105__p343418414516">Whether the request is successful.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0105__section1343410474516"><h4 class="sectiontitle">Example Request</h4><ul id="drs_03_0105__ul1243454154516"><li id="drs_03_0105__li164341349457">Example of a DDS real-time migration connection test:<pre class="screen" id="drs_03_0105__screen51411389262">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-connection</pre>
<pre class="screen" id="drs_03_0105__screen332421719269">{
"jobs" : [ {
"id" : "140b5236-88ad-43c8-811c-1268453jb101",
"ip" : "192.168.4.66:8635,192.168.4.83:8635",
"net_type" : "eip",
"db_type" : "mongodb",
"db_port" : 0,
"db_user" : "root",
"db_password" : "<strong id="drs_03_0105__en-us_topic_0117388899_b11681345144418"><em id="drs_03_0105__en-us_topic_0117388899_i126812457441">********</em></strong>",
"inst_id" : "3cadd5a0ef724f55ac7fa5bcb5f4fc5fin02",
"project_id" : "0549a6a31000d4e82fd1c00c3d6f2d76",
"region" : "eu-de",
"end_point_type" : "ta"
} ]
}</pre>
</li><li id="drs_03_0105__li174361141451">Example of an RDS MySQL real-time migration connection test:<pre class="screen" id="drs_03_0105__screen72401331143018">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-connection</pre>
<pre class="screen" id="drs_03_0105__screen10151906313">{
"jobs" : [ {
"id" : "140b5236-88ad-43c8-811c-1268453jb101",
"ip" : "192.168.0.131",
"net_type" : "eip",
"db_type" : "mysql",
"db_port" : 3306,
"db_user" : "root",
"db_password" : "<strong id="drs_03_0105__b168806215253"><em id="drs_03_0105__i14880182142517">********</em></strong>",
"inst_id" : "e05a3679efe241d8b5dee80b17c1a863in01",
"project_id" : "054ba152d480d55b2f5dc0069e7ddef0",
"region" : "eu-de",
"end_point_type" : "ta"
} ]
}</pre>
</li><li id="drs_03_0105__li19773041456">Example of a real-time MySQL migration connection test:<pre class="screen" id="drs_03_0105__screen1751916483324">https://{Endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-connection</pre>
<pre class="screen" id="drs_03_0105__screen48211458113211">{
"jobs" : [ {
"id" : "140b5236-88ad-43c8-811c-1268453jb101",
"ip" : "192.168.0.27",
"net_type" : "eip",
"db_type" : "mysql",
"db_port" : 3306,
"db_user" : "root",
"db_password" : "<strong id="drs_03_0105__b61445305252"><em id="drs_03_0105__i214453042520">********</em></strong>",
"ssl_link" : false,
"end_point_type" : "so"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="drs_03_0105__section197741646453"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0105__p5774184144515"><strong id="drs_03_0105__b20861540133814">Status code: 200</strong></p>
<p id="drs_03_0105__p157741841459">OK</p>
<pre class="screen" id="drs_03_0105__screen67741948456">{
"results" : [ {
"success" : true,
"id" : "140b5236-88ad-43c8-811c-1268453jb101",
"status" : "success"
} ],
"count" : 1
}</pre>
</div>
<div class="section" id="drs_03_0105__section127741149455"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0105__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0105__row1944114412456"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="drs_03_0105__p1774540451">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_0105__p1877484204510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0105__row1744110414459"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0105__p117748434514">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0105__p167742434515">OK</p>
</td>
</tr>
<tr id="drs_03_0105__row64411454513"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0105__p777412484515">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0105__p177444204511">Bad Request</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0105__section97741411451"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0105__p197756484512">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