forked from docs/doc-exports
Xiong, Chen Xiao
14a6d65e8c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
194 lines
17 KiB
HTML
194 lines
17 KiB
HTML
<a name="dataartsstudio_02_0106"></a><a name="dataartsstudio_02_0106"></a>
|
|
|
|
<h1 class="topictitle1">Importing Connections (to Be Taken Offline)</h1>
|
|
<div id="body0000001104654698"><div class="note" id="dataartsstudio_02_0106__note1300192375913"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0106__dataartsstudio_02_0050_p8251739103613">The connection management capability is provided by Management Center. APIs of Management Center are recommended.</p>
|
|
</div></div>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0106__p11342912131514">This API is used to import one or more connection files from OBS to the Data Development module. Before using this API, store connection files in OBS buckets.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0106__en-us_topic_0181281360_ul145591424184717"><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li356152404715">URI format<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p076674419427"><a name="dataartsstudio_02_0106__en-us_topic_0181281360_li356152404715"></a><a name="en-us_topic_0181281360_li356152404715"></a>POST /v1/{project_id}/connections/import</p>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dataartsstudio_02_0106__en-us_topic_0181281360_ul1370917277482"><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.39%" id="mcps1.3.4.1.1.2.5.1.1"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.4.1.1.2.5.1.2"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.810000000000002%" id="mcps1.3.4.1.1.2.5.1.3"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.190000000000005%" id="mcps1.3.4.1.1.2.5.1.4"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1775345154610">Request parameters</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0106__en-us_topic_0181281360_table1831324784516" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row231318474456"><th align="left" class="cellrowborder" valign="top" width="20.39%" id="mcps1.3.5.3.1.5.1.1"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p2313147104514">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.5.3.1.5.1.2"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p431344794511">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.810000000000002%" id="mcps1.3.5.3.1.5.1.3"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p19313154714451">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.190000000000005%" id="mcps1.3.5.3.1.5.1.4"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p231394774510">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row10313104734510"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.3.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p7313147134519">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.3.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p531314744517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.3.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p83131947104518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.3.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p193135479456">With OBS deployed: OBS path for storing the connection definition file. For details about the format of the job definition file, see the response message of the exported connection.</p>
|
|
<p id="dataartsstudio_02_0106__p7653925151815">Without OBS deployed: local path for storing the connection definition file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row163131647204511"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.3.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p18313194724516">params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.3.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1031374784510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.3.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1831314714455">List<Params></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.3.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p831313476452">Connection parameter. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row43137479454"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.3.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p123131047134518">sameNamePolicy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.3.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p5314547144519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.3.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p203145479455">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.3.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p16314124712452">Policy for specifying how to handle duplicate names. The options are as follows:</p>
|
|
<ul id="dataartsstudio_02_0106__en-us_topic_0181281360_ul3314194714515"><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li931415473456">SKIP</li><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li12328258122318">OVERWRITE<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p171141959162318"><a name="dataartsstudio_02_0106__en-us_topic_0181281360_li12328258122318"></a><a name="en-us_topic_0181281360_li12328258122318"></a>Default value: <strong id="dataartsstudio_02_0106__en-us_topic_0181281360_b116501297468">SKIP</strong></p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p427632784712">Params connection parameters</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0106__en-us_topic_0181281360_table078819233476" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row16788112313474"><th align="left" class="cellrowborder" valign="top" width="20.39%" id="mcps1.3.5.5.1.5.1.1"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p47881523164718">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.61%" id="mcps1.3.5.5.1.5.1.2"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p6788142384711">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.810000000000002%" id="mcps1.3.5.5.1.5.1.3"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p187897234472">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.190000000000005%" id="mcps1.3.5.5.1.5.1.4"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p11789112314711">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row8789122319478"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.5.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1178942324713">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.5.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1878962384714">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.5.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p11789192304715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.5.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p107891923204711">Name of a connection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row15131225154815"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.5.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p131323254486">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.5.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p9132132594810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.5.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p213232534817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.5.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p51328253486">Connection type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row9789142374712"><td class="cellrowborder" valign="top" width="20.39%" headers="mcps1.3.5.5.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p978915235472">params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.61%" headers="mcps1.3.5.5.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p177892231475">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.5.5.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p335135317481">Map<String,Stri</p>
|
|
<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p0351155314819">ng></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.5.5.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1778952319472">Connection parameter. For details about parameter names, see the description of each type of connection configuration item. By default, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section561243517589"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0106__en-us_topic_0181281360_table3593724210" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row2712373429"><th align="left" class="cellrowborder" valign="top" width="20.47%" id="mcps1.3.6.2.1.5.1.1"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1591237154213">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.53%" id="mcps1.3.6.2.1.5.1.2"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p139103734216">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.810000000000002%" id="mcps1.3.6.2.1.5.1.3"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p01011371427">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.190000000000005%" id="mcps1.3.6.2.1.5.1.4"><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1812133774217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0106__en-us_topic_0181281360_row1212837134220"><td class="cellrowborder" valign="top" width="20.47%" headers="mcps1.3.6.2.1.5.1.1 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p425327142211">taskId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.53%" headers="mcps1.3.6.2.1.5.1.2 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p1427182742210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.810000000000002%" headers="mcps1.3.6.2.1.5.1.3 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p62782722212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.190000000000005%" headers="mcps1.3.6.2.1.5.1.4 "><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p228227192214">ID of the task. Used to call the API for querying system tasks to obtain the import status.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section358155716277"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="dataartsstudio_02_0106__en-us_topic_0181281360_screen186651501522">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/import
|
|
{
|
|
"path":"obs://00zyx/2019-07-02/DLF_All_DataConnections.zip",
|
|
"sameNamePolicy":"OVERWRITE",
|
|
"params":[
|
|
{
|
|
"name":"DWS",
|
|
"type":"DWS",
|
|
"params":{
|
|
"clusterName":"cluster1"
|
|
}
|
|
},
|
|
{
|
|
"name":"hive",
|
|
"type":"HIVE",
|
|
"params":{
|
|
"clusterName":"mrs_ymcc",
|
|
"connectionMethod":"agent",
|
|
"userName":"admin",
|
|
"agentName":"cdm-donotdelete",
|
|
"kmsKey":"KMS-42ab"
|
|
}
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0106__section19791883424"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0106__en-us_topic_0181281360_ul13130223205017"><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li149491320463">Success response<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p107513409317"><a name="dataartsstudio_02_0106__en-us_topic_0181281360_li149491320463"></a><a name="en-us_topic_0181281360_li149491320463"></a>HTTP status code 200</p>
|
|
<pre class="screen" id="dataartsstudio_02_0106__en-us_topic_0181281360_screen134017453193">{
|
|
"taskId":"008aae2e675933c7016759418e870000"
|
|
}</pre>
|
|
</li><li id="dataartsstudio_02_0106__en-us_topic_0181281360_li697361214553">Failure response<p id="dataartsstudio_02_0106__en-us_topic_0181281360_p17868101111567"><a name="dataartsstudio_02_0106__en-us_topic_0181281360_li697361214553"></a><a name="en-us_topic_0181281360_li697361214553"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0106__en-us_topic_0181281360_screen31171971269">{
|
|
"error_code":"DLF.0815",
|
|
"error_msg":"Fail to read OBS file."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0106__en-us_topic_0181281360_section1623417185013"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0106__en-us_topic_0181281360_p285775634815">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0049.html">Connection Management APIs (To Be Taken Offline)</a></div>
|
|
</div>
|
|
</div>
|
|
|