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

394 lines
29 KiB
HTML
Raw Blame History

<a name="drs_03_0106"></a><a name="drs_03_0106"></a>
<h1 class="topictitle1">Testing Connections in Batches (Cluster Mode)</h1>
<div id="body9592132415504"><div class="section" id="drs_03_0106__section242914125149"><h4 class="sectiontitle">Function</h4><ul id="drs_03_0106__ul104291612101420"><li id="drs_03_0106__li9429812111415">This API is used to test connections in cluster mode.</li></ul>
</div>
<div class="section" id="drs_03_0106__section3592224145019"><h4 class="sectiontitle">Constraints</h4><p id="drs_03_0106__p125923242505">After the task is created, you can test the connection only when the task status is <strong id="drs_03_0106__b12466121034010">CONFIGURATION</strong>.</p>
</div>
<div class="section" id="drs_03_0106__section35934245501"><h4 class="sectiontitle">URI</h4><p id="drs_03_0106__p11593182410503">POST /v3/{project_id}/jobs/cluster/batch-connection</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__table16593182411501" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="drs_03_0106__row1459342485017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="drs_03_0106__p15931524125017">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_0106__p5594152475018">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_0106__p17594122455015">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_0106__p25941244504">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row059317243504"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="drs_03_0106__p35941024165014">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="drs_03_0106__p135941924205013">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="drs_03_0106__p1359482415505">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="drs_03_0106__p20594924195020">Project ID of a tenant in a region</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0106__section65951524195019"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="drs_03_0106__row95952024105017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="drs_03_0106__p25950240500">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_0106__p059552445019">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_0106__p3596024145012">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_0106__p16596132419505">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row1659532416502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0106__p1159682418501">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0106__p19596112411505">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0106__p6596224165010">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0106__p0438163914167">The content type.</p>
<p id="drs_03_0106__p123256415450">The default value is <strong id="drs_03_0106__b129651123184119">application/json</strong>.</p>
</td>
</tr>
<tr id="drs_03_0106__row165952024155019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0106__p1159613247505">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_0106__p859762475018">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0106__p19597182495011">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0106__p13597172415010">User token obtained from IAM.</p>
</td>
</tr>
<tr id="drs_03_0106__row19595824125011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="drs_03_0106__p18597152419508">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="drs_03_0106__p45971624175019">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="drs_03_0106__p9597152425012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="drs_03_0106__p1759792425020">Request language type</p>
<p id="drs_03_0106__p68691956125917">Default value: <strong id="drs_03_0106__b1060320288417">en-us</strong></p>
<p id="drs_03_0106__p1386915625912">Values:</p>
<ul id="drs_03_0106__ul1586965613591"><li id="drs_03_0106__li1886915655910"><strong id="drs_03_0106__b158691656145912">en-us</strong></li><li id="drs_03_0106__li17869125685916"><strong id="drs_03_0106__b12869175615914">zh-cn</strong></li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__requestParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="drs_03_0106__row959818249509"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="drs_03_0106__p9598102485015">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_0106__p2059817240506">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_0106__p6598112419500">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_0106__p459802445020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row1598724115016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="drs_03_0106__p10599202412509">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="drs_03_0106__p175991424155016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="drs_03_0106__p459915240500">Array of <a href="#drs_03_0106__request_BatchJobActionReq">BatchJobActionReq</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="drs_03_0106__p759915247502">Requests for testing cluster connections in batches.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0106__request_BatchJobActionReq"></a><a name="request_BatchJobActionReq"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__request_BatchJobActionReq" frame="border" border="1" rules="all"><caption><b>Table 4 </b>BatchJobActionReq</caption><thead align="left"><tr id="drs_03_0106__row13600142495014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="drs_03_0106__p1760042413509">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_0106__p12600024125020">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_0106__p156009242504">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_0106__p11601112415017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row166001324185015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0106__p560162411500">action</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0106__p19601224165012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0106__p6601152485019">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0106__p6601324125013">Specific operation to be performed.</p>
</td>
</tr>
<tr id="drs_03_0106__row1760022413500"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0106__p8601152435020">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0106__p146011224185012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0106__p196011024125016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0106__p16602182485014">Task ID. (In cluster mode, the value is the ID of the parent task.).</p>
</td>
</tr>
<tr id="drs_03_0106__row1260016244508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="drs_03_0106__p160292410508">property</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="drs_03_0106__p14602324165013">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="drs_03_0106__p6602724195012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="drs_03_0106__p1260232420503">The parameter that corresponds to the operation.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__table44819714710" frame="border" border="1" rules="all"><caption><b>Table 5 </b>property field description</caption><thead align="left"><tr id="drs_03_0106__row54821371474"><th align="left" class="cellrowborder" valign="top" width="21.27%" id="mcps1.3.4.5.2.5.1.1"><p id="drs_03_0106__p3482117173">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.4.5.2.5.1.2"><p id="drs_03_0106__p24823710717">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.119999999999997%" id="mcps1.3.4.5.2.5.1.3"><p id="drs_03_0106__p4482471715">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.089999999999996%" id="mcps1.3.4.5.2.5.1.4"><p id="drs_03_0106__p12482779718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row2482171717"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p94821472074">dbtype</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p1948237174">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p848220710718">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p124821674714">Database type.</p>
</td>
</tr>
<tr id="drs_03_0106__row9482174712"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p0482271679">dbport</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p20482171273">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p648316719713">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p348318712720">Database port. The value is <strong id="drs_03_0106__b148344458437">0</strong> for the MongoDB engine.</p>
</td>
</tr>
<tr id="drs_03_0106__row174831071773"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p3483127777">ssllink</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p164831376714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p448314714716">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p1612510916548">Whether the connection is an SSL connection. Valid values:</p>
<ul id="drs_03_0106__ul1189891416541"><li id="drs_03_0106__li11898131475416"><strong id="drs_03_0106__b1245812135515">true</strong></li><li id="drs_03_0106__li1589815144547"><strong id="drs_03_0106__b163851714135519">false</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0106__row167959574710"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p157966574717">nettype</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p187961757670">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p479717574713">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p6829161816545">Network type. Valid values:</p>
<ul id="drs_03_0106__ul1212102375510"><li id="drs_03_0106__li2212192395511"><strong id="drs_03_0106__b5759193014557">vpn</strong></li><li id="drs_03_0106__li121217237556"><strong id="drs_03_0106__b1178453015512">vpc</strong></li><li id="drs_03_0106__li182121023135513"><strong id="drs_03_0106__b1381412304556">eip</strong></li></ul>
</td>
</tr>
<tr id="drs_03_0106__row4893631886"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p7893131287">endpointtype</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p138936318816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p88931531985">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p1644517183569">Endpoint type. Valid values:</p>
<ul id="drs_03_0106__ul25423011566"><li id="drs_03_0106__li115411306563"><strong id="drs_03_0106__b747494818455">so</strong>: indicates the source database.</li><li id="drs_03_0106__li1032418411568"><strong id="drs_03_0106__b271560154617">ta</strong>: indicates the destination database.</li><li id="drs_03_0106__li112220431273"><strong id="drs_03_0106__b571491734618">ls</strong>: indicates the sharded database. If the source database is a cluster database, the <strong id="drs_03_0106__b1537153815469">endpointtype</strong> value corresponding to the database IP address is <strong id="drs_03_0106__b1713174720469">so</strong>, and the <strong id="drs_03_0106__b87621913154719">endpointtype</strong> value corresponding to the sharded database is <strong id="drs_03_0106__b11798825184713">ls</strong>.</li></ul>
</td>
</tr>
<tr id="drs_03_0106__row188091111201015"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p381081181020">ip</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p1981031161015">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p8810131181010">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p781001113109">Database IP address.</p>
</td>
</tr>
<tr id="drs_03_0106__row199601914111014"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p13960141491010">dbName</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p13960514191017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p296061431011">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p1196021418105">Database name.</p>
</td>
</tr>
<tr id="drs_03_0106__row8582162951018"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p14582112917105">dbuser</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p158262991012">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p958222911102">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p85821929121012">Database username.</p>
</td>
</tr>
<tr id="drs_03_0106__row971114255105"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p5711162551019">dbpassword</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p14711132591016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p17115254109">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p7711525101019">Database password.</p>
</td>
</tr>
<tr id="drs_03_0106__row630018228103"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p930052281010">sslcertkey</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p13300192291018">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p133001022191011">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p18300822141011">Content of the SSL certificate. This parameter is required for SSL connection.</p>
</td>
</tr>
<tr id="drs_03_0106__row103521518131017"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p935331818105">sslcertname</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p4353518141020">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p535341801010">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p1035315183105">Name of the SSL certificate. This parameter is required for SSL connection.</p>
</td>
</tr>
<tr id="drs_03_0106__row104551959111013"><td class="cellrowborder" valign="top" width="21.27%" headers="mcps1.3.4.5.2.5.1.1 "><p id="drs_03_0106__p174555594107">sslcertchecksum</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.4.5.2.5.1.2 "><p id="drs_03_0106__p16455165913107">No</p>
</td>
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.4.5.2.5.1.3 "><p id="drs_03_0106__p645535981017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.089999999999996%" headers="mcps1.3.4.5.2.5.1.4 "><p id="drs_03_0106__p445545919102">Checksum value of the SSL certificate content, which is required for SSL connections.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0106__section86021524165014"><h4 class="sectiontitle">Response Parameters</h4><p id="drs_03_0106__p160262445018"><strong id="drs_03_0106__b034814335484">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__responseParameter" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="drs_03_0106__row460316247501"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="drs_03_0106__p760352485018">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_0106__p106031424175013">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_0106__p20603162412503">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row5603202413504"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0106__p8604192417505">results</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0106__p1604142415010">Array of <a href="#drs_03_0106__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_0106__p360413241507">Response body set for the batch test connection.</p>
</td>
</tr>
<tr id="drs_03_0106__row0603162415501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="drs_03_0106__p860442485010">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="drs_03_0106__p14604142414507">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="drs_03_0106__p260422417508">Total number of records.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="drs_03_0106__response_CheckJobResp"></a><a name="response_CheckJobResp"></a><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__response_CheckJobResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>CheckJobResp</caption><thead align="left"><tr id="drs_03_0106__row15605324145013"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="drs_03_0106__p260582405020">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_0106__p1460552495012">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_0106__p2605152475012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row060592410509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0106__p26061224135013">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0106__p12606122416505">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0106__p1560612240500">Task ID.</p>
</td>
</tr>
<tr id="drs_03_0106__row176051524115012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0106__p1860602410502">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0106__p1160613249508">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0106__p10606172416507">Test result. Value:</p>
<ul id="drs_03_0106__ul1606132414508"><li id="drs_03_0106__li1760652411500"><strong id="drs_03_0106__b1439645734813">true</strong>: indicates that the connection test is successful.</li><li id="drs_03_0106__li960742420502"><strong id="drs_03_0106__b13361105904817">false</strong>: indicates that the connection test fails.</li></ul>
</td>
</tr>
<tr id="drs_03_0106__row18605142415013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0106__p156071724195015">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0106__p460752405011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0106__p11607162415015">Error code, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0106__row960592414501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0106__p8607132420504">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0106__p4607724105011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0106__p106071424165010">Error message, which is optional and indicates the returned information about the failure status.</p>
</td>
</tr>
<tr id="drs_03_0106__row11605202425020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="drs_03_0106__p76081224125016">success</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="drs_03_0106__p1460812246509">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="drs_03_0106__p11608192419501">Whether the request is successful.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0106__section6608424105015"><h4 class="sectiontitle">Example Request</h4><ul id="drs_03_0106__ul1604194918522"><li id="drs_03_0106__li72158521">Example of testing the connection to the source DDS cluster.<pre class="screen" id="drs_03_0106__screen750144810439">https://{EndPoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/cluster/batch-connection</pre>
<pre class="screen" id="drs_03_0106__screen818734419436">{
"jobs" : [ {
"action" : "testConnection",
"job_id" : "35d0d60b-4605-4686-b35d-3a3d059fjb15",
"property" : "[{\"dbtype\":\"mongodb\",\"dbport\":0,\"ssllink\":false,\"nettype\":\"eip\",\"endpointtype\":\"so\",\"encrypt\":{\"elementId\":\"encrypt_switch\",\"offLabel\":\"OFF\",\"onLabel\":\"ON\",\"disable\":false,\"ip\":\"192.168.7.217:8635\",\"dbName\":\"admin\",\"dbuser\":\"rwuser\",\"dbpassword\":\"xxxx\"},{\"dbtype\":\"mongodb\",\"dbport\":0,\"ssllink\":false,\"nettype\":\"eip\",\"endpointtype\":\"so\",\"encrypt\":{\"elementId\":\"encrypt_switch\",\"offLabel\":\"OFF\",\"onLabel\":\"ON\",\"disable\":false,\"ip\":\"192.168.7.72:8635\",\"dbName\":\"admin\",\"dbuser\":\"rwuser\",\"dbpassword\":\"xxxx\"},{\"ip\":\"192.168.7.37:8635\",\"nettype\":\"eip\",\"dbtype\":\"mongodb\",\"dbport\":0,\"dbuser\":\"rwuser\",\"dbpassword\":\"xxxx\",\"ssllink\":false,\"sslcertkey\":\"\",\"sslcertname\":\"\",\"sslcertchecksum\":\"\",\"endpointtype\":\"ls\",\"dbName\":\"admin\"}]"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="drs_03_0106__section166091724105012"><h4 class="sectiontitle">Example Response</h4><p id="drs_03_0106__p66097247503"><strong id="drs_03_0106__b16421052124911">Status code: 200</strong></p>
<p id="drs_03_0106__p146092024105015">OK</p>
<pre class="screen" id="drs_03_0106__screen17610624165011">{
"results" : [ {
"id" : "0eb704d0-5a1c-4cbd-b675-91152f06jb11",
"status" : "true"
} ],
"count" : 1
}</pre>
</div>
<div class="section" id="drs_03_0106__section18610624185015"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="drs_03_0106__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="drs_03_0106__row2610122411502"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="drs_03_0106__p4611122435015">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_0106__p1661132412506">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="drs_03_0106__row961052418504"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0106__p2061122435017">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0106__p15611924165014">OK</p>
</td>
</tr>
<tr id="drs_03_0106__row1261014241506"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="drs_03_0106__p106112244504">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="drs_03_0106__p13611112475015">Bad Request</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="drs_03_0106__section761272475010"><h4 class="sectiontitle">Error Code</h4><p id="drs_03_0106__p061262414509">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