GetSFTP

文档中心 › 组件索引 › GetSFTP

GetSFTP Processor

类型全限定名：cn.org.acal.lynxus.processors.standard.GetSFTP

所属 Bundle：cn.org.acal.lynxus:lynxus-standard-nar:2.11.8

描述

从 SFTP 服务器获取文件并从中创建 FlowFiles

标签

sftpgetretrievefilesfetchremoteingestsourceinput

属性

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称默认值可选值描述
Hostname远程系统的完全限定主机名或 IP 地址
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Port22远程系统正在侦听文件传输的端口
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Username用户名
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Password用户帐户的密码
敏感属性：是
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Private Key Path私钥文件的完全限定路径
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Private Key Passphrase私钥的密码
敏感属性：是
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Remote Path远程系统上从中拉取或推送文件的路径
支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
File Filter Regex提供Java正则表达式用于过滤文件名； 如果提供了过滤器，则仅获取名称与正则表达式匹配的文件
Path Filter Regex当'递归搜索'为 true 时，仅扫描路径匹配给定正则表达式的子目录
Polling Interval60 sec确定获取新文件列表之间等待的时间
Search Recursivelyfalse
  • true
  • false
如果为 true，将从任意嵌套的子目录中提取文件； 否则，不会遍历子目录
Follow Symbolic Linksfalse
  • true
  • false
如果为 true，则甚至会拉取符号文件以及嵌套的符号子目录； 否则，不会读取符号文件，也不会遍历符号链接子目录
Ignore Dotted Filestrue
  • true
  • false
如果为 true，名称以点开头的文件（'.'）将被忽略
Delete Originaltrue
  • true
  • false
确定文件成功传输后是否从远程系统中删除
Connection Timeout30 sec创建连接时超时之前等待的时间量
Data Timeout30 sec在本地和远程系统之间传输文件时，该值指定允许在系统之间不传输任何数据的时间长度
Host Key File如果提供，给定的文件将用作主机密钥；否则，如果应用了 'Strict Host Key Checking' 属性（设置为 true），则使用 ~/.ssh 目录中的 'known_hosts' 和 'known_hosts2' 文件，否则不使用主机密钥文件。
Max Selects100单个连接中拉取的最大文件数
Remote Poll Batch Size5000指定在远程系统上执行文件列表时，在给定目录中查找多少个文件路径。此值通常不需要修改，但在对包含大量文件的远程系统进行轮询时，此值可能至关重要。设置过高会导致性能很差，设置过低会导致流程比正常情况慢。
Strict Host Key Checkingfalse
  • true
  • false
指示是否应严格执行主机密钥
Send Keep Alive On Timeouttrue
  • true
  • false
每 5 秒发送一条“保持活动”消息，最多发送 5 次，总超时时间为 25 秒。
Use Compressionfalse
  • true
  • false
指示传输文件时是否应使用 ZLIB 压缩
Use Natural Orderingfalse
  • true
  • false
如果为 true，将按照文件自然列出的顺序拉取文件； 否则，未定义拉取文件的顺序
Proxy Configuration Service控制器服务 API：
ProxyConfigurationService
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8		指定代理配置 Controller Service 来代理网络请求。
Algorithm NegotiationDEFAULT
  • DEFAULT — 基于标准设置的默认算法协商，以与 SSH 服务器保持通用兼容性
  • CUSTOM — 基于所定义设置的自定义算法协商
SSH算法协商配置策略
Ciphers Allowed允许的 SFTP 连接密码的逗号分隔列表。留空以允许所有。可用选项包括：3des-cbc, aes128-cbc, aes128-ctr, aes128-gcm@openssh.com, aes192-cbc, aes192-ctr, aes256-cbc, aes256-ctr, aes256-gcm@openssh.com, arcfour128, arcfour256, blowfish-cbc, chacha20-poly1305@openssh.com, none
支持表达式语言：是（仅使用环境/系统变量求值）
Key Algorithms Allowed允许的 SFTP 连接密钥算法的逗号分隔列表。留空以允许所有。可用选项包括：ecdsa-sha2-nistp256, ecdsa-sha2-nistp256-cert-v01@openssh.com, ecdsa-sha2-nistp384, ecdsa-sha2-nistp384-cert-v01@openssh.com, ecdsa-sha2-nistp521, ecdsa-sha2-nistp521-cert-v01@openssh.com, rsa-sha2-256, rsa-sha2-256-cert-v01@openssh.com, rsa-sha2-512, rsa-sha2-512-cert-v01@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com, sk-ssh-ed25519@openssh.com, ssh-dss, ssh-dss-cert-v01@openssh.com, ssh-ed25519, ssh-ed25519-cert-v01@openssh.com, ssh-rsa, ssh-rsa-cert-v01@openssh.com
支持表达式语言：是（仅使用环境/系统变量求值）
Key Exchange Algorithms Allowed允许的 SFTP 连接密钥交换算法的逗号分隔列表。留空以允许所有。可用选项包括：curve25519-sha256, curve25519-sha256@libssh.org, curve448-sha512, diffie-hellman-group-exchange-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group1-sha1, diffie-hellman-group14-sha1, diffie-hellman-group14-sha256, diffie-hellman-group15-sha512, diffie-hellman-group16-sha512, diffie-hellman-group17-sha512, diffie-hellman-group18-sha512, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, mlkem1024nistp384-sha384, mlkem768nistp256-sha256, mlkem768x25519-sha256, sntrup761x25519-sha512, sntrup761x25519-sha512@openssh.com
支持表达式语言：是（仅使用环境/系统变量求值）
Message Authentication Codes Allowed允许的 SFTP 连接消息认证码的逗号分隔列表。留空以允许所有。可用选项包括：hmac-md5, hmac-md5-96, hmac-sha1, hmac-sha1-96, hmac-sha1-etm@openssh.com, hmac-sha2-256, hmac-sha2-256-etm@openssh.com, hmac-sha2-512, hmac-sha2-512-etm@openssh.com
支持表达式语言：是（仅使用环境/系统变量求值）

关系 (Relationships)

名称描述自动终止
success所有收到的 FlowFiles 都会成功路由否

写入的 FlowFile 属性

名称描述
filename文件名设置为远程服务器上的文件名
path路径设置为文件目录在远程服务器上的路径。例如，如果 <Remote Path> 属性设置为 /tmp，从 /tmp 拾取的文件的路径属性设置为 /tmp。如果 <Search Recursively> 属性设置为 true 且从 /tmp/abc/1/2/3 拾取文件，则路径属性设置为 /tmp/abc/1/2/3
file.lastModifiedTime源文件上次修改的日期和时间
file.owner源文件的数字所有者 ID
file.group源文件的数字组 ID
file.permissions源文件的读/写/执行权限
absolute.path文件被拾取的完整/绝对路径。当前的 'path' 属性仍然被填充，但可能是相对路径

状态管理

该组件不存储状态。

受限 (Restricted)

该组件不受限。

输入要求

该组件不允许有传入连接。

另请参阅

© 2026 ACAL Organization. Licensed under Apache License 2.0.