doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0270.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version
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>
2024-03-01 11:46:15 +00:00

99 lines
6.6 KiB
HTML

<a name="dataartsstudio_02_0270"></a><a name="dataartsstudio_02_0270"></a>
<h1 class="topictitle1">Link to an FTP or SFTP Server</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0270__en-us_topic_0108272835_section621837"><h4 class="sectiontitle">Description</h4><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p27768935">By creating an FTP or SFTP link, you are able to extract files from or load files to the FTP or SFTP server. Files in CSV, JSON, and binary format are supported.</p>
</div>
<div class="section" id="dataartsstudio_02_0270__en-us_topic_0108272835_section6163607716523"><h4 class="sectiontitle">Sample Link</h4><pre class="screen" id="dataartsstudio_02_0270__en-us_topic_0108272835_screen64548357171929">{
"links": [
{
"link-config-values": {
"configs": [
{
"inputs": [
{
"name": "linkConfig.server",
"value": "10.120.85.167"
},
{
"name": "linkConfig.port",
"value": "22"
},
{
"name": "linkConfig.username",
"value": "<em id="dataartsstudio_02_0270__en-us_topic_0108272835_i2136951595733">username</em>"
},
{
"name": "linkConfig.password",
"value": "<em id="dataartsstudio_02_0270__en-us_topic_0108272835_i6170414145959">Add password here</em>"
}
],
"name": "linkConfig"
}
]
},
"name": "sftp_link",
"connector-name": "sftp-connector"
}
]
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0270__en-us_topic_0108272835_section5035508012043"><h4 class="sectiontitle">Link Parameters</h4><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p18106682113650">Parameters for creating the FTP or SFTP link are the same.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0270__en-us_topic_0108272835_table13922888141527" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0270__en-us_topic_0108272835_row229143141527"><th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.3.3.1.5.1.1"><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p66756185141527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.34%" id="mcps1.3.3.3.1.5.1.2"><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p38541938141527">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.68%" id="mcps1.3.3.3.1.5.1.3"><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p34889279141527">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.14%" id="mcps1.3.3.3.1.5.1.4"><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p7459369141527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0270__en-us_topic_0108272835_row2725489141730"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.5.1.1 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p18261829141730">linkConfig.server</p>
</td>
<td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.3.1.5.1.2 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p2813219141730">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.3.3.1.5.1.3 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p26544197141730">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.14%" headers="mcps1.3.3.3.1.5.1.4 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p2596372141730">IP address of the FTP or SFTP server</p>
</td>
</tr>
<tr id="dataartsstudio_02_0270__en-us_topic_0108272835_row302832141730"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.5.1.1 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p13707316141730">linkConfig.port</p>
</td>
<td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.3.1.5.1.2 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p36550801141730">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.3.3.1.5.1.3 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p7824886141730">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.14%" headers="mcps1.3.3.3.1.5.1.4 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p29836044141730">Port number of the FTP or SFTP server</p>
</td>
</tr>
<tr id="dataartsstudio_02_0270__en-us_topic_0108272835_row14946728141730"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.5.1.1 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p7204562141730">linkConfig.username</p>
</td>
<td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.3.1.5.1.2 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p46698681141730">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.3.3.1.5.1.3 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p24496779141730">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.14%" headers="mcps1.3.3.3.1.5.1.4 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p38082098141730">Username for logging in to the FTP or SFTP server</p>
</td>
</tr>
<tr id="dataartsstudio_02_0270__en-us_topic_0108272835_row53856530141730"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.3.3.1.5.1.1 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p45889226141730">linkConfig.password</p>
</td>
<td class="cellrowborder" valign="top" width="20.34%" headers="mcps1.3.3.3.1.5.1.2 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p26039827141730">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.68%" headers="mcps1.3.3.3.1.5.1.3 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p28851277141730">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.14%" headers="mcps1.3.3.3.1.5.1.4 "><p id="dataartsstudio_02_0270__en-us_topic_0108272835_p55252128141730">Password for logging in to the FTP or SFTP server</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="link_parameter.html">Link Parameter Description</a></div>
</div>
</div>