SFTP 命令

要作为链的一部分与单个安全文件传输协议 (SFTP) 服务器交互，可添加一个包含 SFTP 连接命令的步骤。

注：要使用此连接器，贵组织需要访问自己的 SFTP 服务器。Workiva 不会，也不会托管或提供 SFTP 服务器。

要启用这些命令，IT 管理员首先要配置 SFTP 连接。

删除

要删除 SFTP 服务器上的文件和文件夹，请使用 Delete 命令。

属性

摘要信息	详细信息
文件	输入要删除的文件和文件夹。要匹配多个文件和文件夹，请使用通配符 `*`。
跳过文件夹	要忽略与指定文件匹配的文件夹，请选中此复选框。
递归	要删除指定文件夹及其全部内容，请选中此复选框。

输出

输出	输出类型
删除的文件	JSON
删除的文件夹	JSON
删除所有项目	JSON

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
6	错误	未将标记为删除的目录设置为跳过，也未将递归设置为

下载文件

要从 SFTP 服务器下载文件，请使用 Download File 命令。

属性

摘要信息	详细信息
文件	输入要从 SFTP 服务器检索的文件名。注意：如果在组迭代中使用此命令，请使用命令迭代器的远程文件迭代变量来标识文件。
并行下载	要启用并行下载（如下载大文件），请选中此复选框。
线程数	如果选择 Parallel Download，请选择并行运行的线程数量。如果不确定，请保留默认值 3。

输出

输出	输出类型
下载文件	文件

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败

获取

要从 SFTP 服务器检索文件，请使用 Get 命令。

属性

摘要信息	详细信息
文件	输入要检索的文件。要匹配多个文件，请使用通配符 `*`。
目的地	输入文件的目的地。要检索多个文件，请输入目录。

输出

输出	输出类型
检索文件	JSON
检索文件（文本）	字串

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
6	错误	没有跳过和标记要删除的目录，也没有设置递归

列表目录

要列出 SFTP 服务器上某个目录中的文件，请使用 List Directory 命令。

属性

摘要信息	详细信息
目录	输入要列出内容的目录。要列出目录中的多个文件和文件夹，请使用通配符 ``。注意：* 如果使用此命令列出文件，供以后的迭代下载文件命令使用，请包含要下载的文件名。如果每次迭代都会更改名称，例如根据日期或时间戳更改名称，则包含通配符 `*`。
详细程度	选择显示文件和文件夹的详细程度：简短的，仅用于文件和文件夹的名称完整的, 包含名称和其他信息，包括所有权和权限

输出

输出	输出类型
远程文件	JSON

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
5	错误	未找到指定目录

制作目录

要在 SFTP 服务器上创建新目录，请使用 Make Directory 命令。

属性

摘要信息	详细信息
目录	输入要在 SFTP 服务器上创建的目录。
递归	要创建不存在的目录的整个路径，请选中此复选框。

输出

没有任何

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
4	错误	创建指定目录出错
6	成功	目录已存在

移动

要在 SFTP 服务器上移动文件，请使用 Move 命令。

属性

摘要信息	详细信息
文件	输入要移动的文件。要匹配多个文件和文件夹，请使用通配符 `*`。
目的地	输入文件的目的地。要移动多个文件，请输入目录。

输出

输出	输出类型
移动的文件	JSON
移动的文件（文本）	字串

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
4	错误	移动多个文件时，目的地必须是现有目录
5	错误	未找到指定源文件的文件

把

要将文件上传到 SFTP 服务器，请使用 Put 命令。

属性

摘要信息	详细信息
文件	输入要上传的文件。要匹配多个文件和文件夹，请使用通配符 `*`。
目的地	输入文件的目的地。要上传多个文件，请输入目录。

输出

输出	输出类型
远程文件	JSON
远程文件（文本）	字串

退出代码

代码	类型	详细信息
0	成功	成功
2	错误	任务失败
6	错误	目录未跳过和标记为删除，但未设置递归

支持

Workiva 支持中心

SFTP 命令

注：要使用此连接器，贵组织需要访问自己的 SFTP 服务器。Workiva 不会，也不会托管或提供 SFTP 服务器。

删除

属性

输出

退出代码

下载文件

属性

注意：如果在组迭代中使用此命令，请使用命令迭代器的远程文件迭代变量来标识文件。

输出

退出代码

获取

属性

输出

退出代码

列表目录

属性

注意：如果使用此命令列出文件，供以后的迭代下载文件命令使用，请包含要下载的文件名。如果每次迭代都会更改名称，例如根据日期或时间戳更改名称，则包含通配符 `*`。

输出

退出代码

制作目录

属性

输出

退出代码

移动

属性

输出

退出代码

把

属性

输出

退出代码

Workiva 支持中心

SFTP 命令

注： 要使用此连接器，贵组织需要访问自己的 SFTP 服务器。Workiva 不会 ，也不会 托管或提供 SFTP 服务器。

删除

属性

输出

退出代码

下载文件

属性

注意： 如果在组迭代中使用此命令，请使用命令迭代器的 远程文件迭代 变量来标识文件。

输出

退出代码

获取

属性

输出

退出代码

列表目录

属性

注意： 如果使用此命令列出文件，供以后的迭代下载文件命令使用，请包含要下载的文件名。如果每次迭代都会更改名称，例如根据日期或时间戳更改名称，则包含通配符 *。

输出

退出代码

制作目录

属性

输出

退出代码

移动

属性

输出

退出代码

把

属性

输出

退出代码

注：要使用此连接器，贵组织需要访问自己的 SFTP 服务器。Workiva 不会，也不会托管或提供 SFTP 服务器。

注意：如果在组迭代中使用此命令，请使用命令迭代器的远程文件迭代变量来标识文件。

注意：如果使用此命令列出文件，供以后的迭代下载文件命令使用，请包含要下载的文件名。如果每次迭代都会更改名称，例如根据日期或时间戳更改名称，则包含通配符 `*`。