SFTP 命令

要与链中的单个安全文件传输协议 (SFTP) 服务器进行交互，请添加包含 SFTP 连接命令的步骤。

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

。

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

删除

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

属性

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

输出

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

退出代码

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

下载文件

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

属性

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

输出

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

退出代码

代码	类型	细节
0	成功	成功
2	错误	任务失败

得到

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

属性

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

输出

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

退出代码

代码	类型	细节
0	成功	成功
2	错误	任务失败
6	错误	目录未被跳过或标记为删除，且未设置递归删除。

列表目录

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

属性

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

输出

输出类型

远程文件

JSON

远程文件详情

JSON（文件）
自 2025 年 9 月 11 日起生效，此数组包含一个 JSON 文件数组，其中包含以下字段：

modifiedTime = SFTP 文件上次修改的时间
模式 = 文件模式
remoteFile = 远程文件的路径（这与另一个输出一致）
accessedTime = 上次访问 SFTP 文件的时间

示例：
[{"modifiedTime":"2025年9月10日星期三 03:15:15 UTC","size":"60","mode":"-rwxrwxr-x", "remoteFile":"/tmp/somefile.txt","accessedTime":"2025年9月10日星期三 03:15:15 UTC"},{"modifiedTime":"2025年9月10日星期三 02:37:36 UTC","size":"60","mode":"drwxrwxr-x", "remoteFile":"/tmp/someDir","accessedTime":"2025年9月10日星期三 02:37:36 UTC"}]

退出代码

代码	类型	细节
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 Support Center

SFTP 命令

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

删除

属性

输出

退出代码

下载文件

属性

注意：如果将此命令与分组迭代一起使用，请使用命令迭代器的远程文件迭代变量来标识文件。

输出

退出代码

得到

属性

输出

退出代码

列表目录

属性

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

输出

退出代码

创建目录

属性

输出

退出代码

移动

属性

输出

退出代码

放

属性

输出

退出代码

Workiva Support Center

SFTP 命令

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

删除

属性

输出

退出代码

下载文件

属性

注意： 如果将此命令与分组迭代一起使用，请使用命令迭代器的 远程文件迭代 变量来标识文件。

输出

退出代码

得到

属性

输出

退出代码

列表目录

属性

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

输出

退出代码

创建目录

属性

输出

退出代码

移动

属性

输出

退出代码

放

属性

输出

退出代码

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

注意：如果将此命令与分组迭代一起使用，请使用命令迭代器的远程文件迭代变量来标识文件。

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