FetchSFTP
描述:
从远程SFTP服务器获取文件的内容，并使用远程文件的内容覆盖输入数据流的内容。
标签:
sftp, get, retrieve, files, fetch, remote, ingest, source, input
参数:
如下列表中，必填参数则标识为加粗. 其他未加粗参数，则表示为可选参数。表中同时提到参数默认值设置, 参数还支持 表达式语言, 并且 如果将一个参数认定为"敏感", 表示是加密状态. 在输入一个敏感参数时, 确保 orchsym.properties 文件中存在属性设置 orchsym.sensitive.props.key.
| 名字 | 默认值 | 允许值列表 | 描述 |
|---|---|---|---|
| 主机 | 获取数据的主机名或IP地址。 支持表达式语言 (支持流属性和变量) | ||
| 端口号 | 22 | 远程主机获取数据的端口 支持表达式语言 (支持流属性和变量) | |
| 用户名 | 用户名 支持表达式语言 (支持流属性和变量) | ||
| 用户密码 | 用户密码 敏感状态 支持表达式语言 (支持流属性和变量) | ||
| 私钥路径 | 私钥文件的完全限定路径 支持表达式语言 (支持流属性和变量) | ||
| 私钥密码 | 私钥的密码 敏感状态 支持表达式语言 (支持流属性和变量) | ||
| 远程文件 | 远程系统上的文件名 支持表达式语言 (支持流属性和变量) | ||
| 执行策略 | 无 | - 无  - 移动文件 - 删除文件 | 指定在将其拉入Studio后如何处理服务器上的原始文件。 如果完成策略失败，将记录警告但数据仍将被传输。 |
| 移动到目标目录 | 将原始文件读取后，文件要迁移的远程服务器上的目录。 除非<执行策略>设置为“移动文件”，否则将忽略此属性。 如果禁用<创建目录>，则指定的目录必须已存在于远程系统上，否则重命名将失败。 支持表达式语言 (支持流属性和变量) | ||
| 创建目录 | 不创建 | - 创建 - 不创建 | 当<执行策略>设置为“移动文件”时使用。 指定是否应创建远程目录（如果不存在）。 |
| 禁用目录列表 | 不禁用 | - 禁用 - 不禁用 | 如果设置为禁用，则在创建缺失目录之前不会执行目录列表。 默认情况下，此组件执行目录列表命令以在创建缺失目录之前查看目标目录。 但是，有些情况下您可能需要禁用目录列表，如下所示。 目录列表可能会失败，并在目录上使用某些权限设置（例如chmod 100）。 此外，如果任何其他SFTP客户端在此组件执行列表之后并且在此组件的目录创建请求完成之前创建了目录，则会返回错误，因为该目录已存在。 |
| 连接超时 | 30 sec | 创建连接时超时之前等待的时间 | |
| 数据超时 | 30 sec | 在本地系统和远程系统之间传输文件时，此值指定在系统之间没有任何数据传输的情况下允许的时间 | |
| 超时是否发送活跃消息 | 是 | - 是 - 否 | 指示SSH连接超时时是否发送单个保持活跃消息 |
| 主机密钥文件 | 如果提供，则给定文件将用作主机密钥; 否则，将不使用主机密钥文件 | ||
| 严格的主机秘钥验证 | 否 | - 是 - 否 | 指示是否应该严格执行主机密钥 |
| 启用压缩 | 不启用 | - 启用 - 不启用 | 指示传输文件时是否应使用ZLIB压缩 |
| 代理配置 | 控制器服务API: ProxyConfigurationService 实现: StandardProxyConfigurationService | 提供代理配置服务，如果设置，将取代每个组件的代理设置。且支持 SOCKS 和HTTP + AuthN | |
| 代理类型 | DIRECT | - DIRECT - HTTP - SOCKS | 用于文件传输的代理类型 |
| 代理主机 | 代理主机名或IP地址 支持表达式语言 (仅支持变量) | ||
| 代理端口号 | 代理服务器的代理端口号 支持表达式语言 (仅支持变量) | ||
| Http代理用户名 | Http代理用户名 支持表达式语言 (仅支持变量) | ||
| Http代理用户密码 | Http代理用户密码 敏感状态 支持表达式语言 (仅支持变量) |
连线:
| 名字 | 描述 |
|---|---|
| success | 成功读取的数据流都将输出到此连线。 |
| comms.failure | 由于通信故障而无法从远程服务器获取的任何数据流将被输出到此连线。 |
| not.found | 从远程服务器收到“未找到”消息的任何数据流都将被输出到此连线。 |
| permission.denied | 由于权限不足而无法从远程服务器获取的任何数据流都将被输出到此连线。 |
读取属性:
未提供。
写入属性:
| 名字 | 描述 |
|---|---|
| sftp.remote.host | 提取文件的远程主机名或IP地址 |
| sftp.remote.port | 用于与远程SFTP服务器通信的端口 |
| sftp.remote.filename | 已拉取的远程文件的名称 |
| filename | 文件名更新为指向远程文件的文件名 |
| path | 如果远程文件包含目录名，则该目录名将使用“path”属性添加到数据流中 |
状态管理:
该组件不保存状态。
限制:
该组件没有限制
输入流要求:
组件必须提供输入流。
系统资源考量:
未提供。