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>
88 lines
9.6 KiB
HTML
88 lines
9.6 KiB
HTML
<a name="dataartsstudio_02_0055"></a><a name="dataartsstudio_02_0055"></a>
|
|
|
|
<h1 class="topictitle1">Exporting Connections (to Be Taken Offline)</h1>
|
|
<div id="body0000001151174551"><div class="note" id="dataartsstudio_02_0055__note1300192375913"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0055__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_0055__en-us_topic_0181281331_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p1912913467404">This API is used to export all connection information that is compressed in ZIP format.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul145591424184717"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li356152404715">URI format<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p076674419427"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li356152404715"></a><a name="en-us_topic_0181281331_li356152404715"></a>POST /v1/{project_id}/connections/export</p>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul1370917277482"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0055__en-us_topic_0181281331_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_0055__en-us_topic_0181281331_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.4.1.1.2.5.1.1"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.4.1.1.2.5.1.2"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.4.1.1.2.5.1.3"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.169999999999995%" id="mcps1.3.4.1.1.2.5.1.4"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.4.1.1.2.5.1.1 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.4.1.1.2.5.1.2 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.4.1.1.2.5.1.3 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.4.1.1.2.5.1.4 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_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_0055__en-us_topic_0181281331_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0055__en-us_topic_0181281331_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.5.2.2.5.1.1"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.5.2.2.5.1.2"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p3149113112204">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.5.2.2.5.1.3"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p13149173119204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.5.2.2.5.1.4"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.5.2.2.5.1.1 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.5.2.2.5.1.2 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p4150531152016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.5.2.2.5.1.3 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p181505317209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.5.2.2.5.1.4 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0055__b107001330684">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section561243517589"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p7541145513348">The value of <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b766312504384">Content-Type</strong> in the response message is <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b10636115818387">application/octet-stream</strong> that needs to be converted into a file. For details, see <a href="dataartsstudio_02_0317.html">Parsing a Stream in a Response Message</a>. Response messages are compressed as a file. The file name format is <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b115476032115">DLF_All_DataConnections.zip</strong>. The file directory is as follows:</p>
|
|
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen10761137172910">connections
|
|
├─{dwsConnection}.conn</pre>
|
|
<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p1229207392"></p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0055__en-us_topic_0181281331_p1488816432455">Export a connection.<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen165211354306">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/export</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0055__section19264922155717"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul13130223205017"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li149491320463">Success response<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p107513409317"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li149491320463"></a><a name="en-us_topic_0181281331_li149491320463"></a>HTTP status code 200</p>
|
|
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen134017453193">Response messages are compressed as a file. The file directory is as follows:
|
|
connections
|
|
├─{dwsConnection}.conn</pre>
|
|
</li><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li697361214553">Failure response<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p17868101111567"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li697361214553"></a><a name="en-us_topic_0181281331_li697361214553"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen31171971269">{
|
|
"error_code":"DLF.6322",
|
|
"error_msg":"The data connection does not exist."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section1623417185013"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_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>
|
|
|