${title}

导读

定义一个 Ftp 协议测试任务，用于 Ftp 功能、性能、稳定性和自定义测试。

字段名称	类型	是否必须	长度限制	描述
target	enum	是	/	编排元素类型，固定值：FTP。
name	string	是	400	Ftp 名称。
description	string	否	800	Ftp 描述。
enabled	boolean	是	/	是否启用Ftp任务，默认开启。
beforeName	string	否	400	Ftp 之前元素名称(用于控制 Pipeline 中元素顺序)，为空时取上一个元素名称。
server	object	是	/	Ftp 服务器配置，具体参数请查看下面“Ftp 服务器配置(server)”配置说明。
uploadFile	boolean	是	/	是否上传文件，值为 true 时上传，false 时下载，默认 false。
uploadFileSource	enum	否	/	上传文件来源，支持值：REMOTE_FILE、REMOTE_URL、LOCAL_FILE(默认)，具体参数请查看下面“上传文件来源”配置说明。
remoteFileName	string	否	4096	远程文件名，下载时远程 FTP 服务器中文件名称，或者上传时保存文件名称。
remoteFileUrl	string	否	4096	远程文件 URL，用于上传时根据 URL 下载一个上传文件。
localFileName	string	否	4096	本地文件名，即上传本地文件的名称，也可以是一个完整本地文件路径。
localFileContent	string	否	2097152	本地文件原始内容，或通过 base64 和 gzip_base64 编码后内容，最大支持 1MB 文件。
localFileContentEncoding	enum	否	/	本地文件编码格式，支持值：none(默认)、base64、gzip_base64。
binaryMode	boolean	否	/	上传文件是否二进制文件。

当前信息可以通过脚本规范"扩展字段"进行扩展。

注意：支持同时编排多个 Ftp 接口，但每次只允许启用一个 Ftp 进行测试。

Ftp 完整参数配置示例：

target: FTP
name: UploadFromLocalFile
description: Upload file from local file
enabled: true
server:
  server: localhost
  port: 8084
  username: admin
  password: 123456
  readTimeout: 60s
  connectTimeout: 6s
uploadFile: true
uploadFileSource: LOCAL_FILE
remoteFileName: remote.txt
localFileName: local.txt
localFileContent: This is a text file content
localFileContentEncoding: none
binaryMode: false

Ftp 服务器配置(server)

字段名称	类型	是否必须	长度限制	描述
server	string	是	/	Ftp 服务器 IP。
port	Integer	是	1 ~ 65535	Ftp 服务器端口。
username	string	否	400	Ftp 服务器认证用户名。
password	string	否	4096	Ftp 服务器认证密码。
readTimeout	string	否	1s ～ 86400s	读取超时。指定客户端未收到关闭连接的服务器响应的时间，默认为 60 秒。
connectTimeout	string	否	1s ～ 86400s	连接超时时间。指定客户端和服务器建立连接的最长等待时间，默认为 6 秒。

当前信息可以通过脚本规范"扩展字段"进行扩展。

server:
  server: localhost
  port: 8084
  username: admin
  password: 123456
  readTimeout: 60s
  connectTimeout: 6s

上传文件来源(uploadFileSource)

REMOTE_FILE：从 Ftp 服务中下载对应文件用于上传。
REMOTE_URL：根据远程 URL 资源下载文件用于上传。
LOCAL_FILE：上传本地文件。

脚本示例(target)

从 Ftp 服务中下载对应文件用于上传示例：

- target: FTP
  name: UploadFromRemoteFtpFile
  description: Download a file from the Ftp server and then upload it
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  uploadFileSource: REMOTE_FILE
  remoteFileName: remote.txt

根据远程 URL 资源下载文件用于上传示例：

- target: FTP
  name: UploadFromRemoteUrl
  description: Download a file from the Ftp server and then upload it
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  uploadFileSource: REMOTE_URL
  remoteFileUrl: https://pics6.baidu.com/feed/d50735fae6cd7b897fbfd8ad27e746a9d8330e1a.jpeg

上传本地文件示例：

- target: FTP
  name: UploadFromLocalFile
  description: Upload file from local file
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  uploadFileSource: LOCAL_FILE
  remoteFileName: remote.txt
  localFileName: local.txt
  localFileContent: This is a text file content

上传本地文件Base64编码示例：

- target: FTP
  name: UploadAndEncodingFromLocalFile
  description: Upload and encode file from local file
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  uploadFileSource: LOCAL_FILE
  remoteFileName: remote.txt
  localFileName: local.txt
  localFileContent: VGhpcyBpcyBhIHRleHQgZmlsZSBjb250ZW50
  localFileContentEncoding: base64
  binaryMode: false

下载文件实例：

- target: FTP
  name: RetrieveFile
  description: Retrieve file from remote Ftp server
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  remoteFileName: test.txt

下载并重命名文件示例：

- target: FTP
  name: RetrieveAndRenameFile
  description: "Retrieve file from remote Ftp server and save it. Note: By default,\
    \ it is saved in the execution data directory."
  server:
    server: localhost
    port: 8084
    username: admin
    password: 123456
  uploadFile: true
  remoteFileName: remote.txt
  localFileName: new_file.txt