FTP
您可以使用 FTP 连接器连接到 FTP 服务器，并执行文件传输操作。
准备工作
在使用 FTP 连接器之前，请先完成以下任务：
- 在您的 Google Cloud 项目中：
- 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
- 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号：
roles/secretmanager.viewerroles/secretmanager.secretAccessor
服务账号是一种特殊类型的 Google 账号，用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号，则必须创建一个服务账号。连接器和服务账号必须属于同一项目。如需了解详情，请参阅创建服务账号。
- 启用以下服务：
secretmanager.googleapis.com(Secret Manager API)connectors.googleapis.com(Connectors API)
如需了解如何启用服务，请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限，则在您配置连接器时，系统会提示您启用。
配置连接器
一个连接需专用于一个数据源。这意味着，如果您有许多数据源，则必须为每个数据源创建单独的连接。如需创建连接，请执行以下操作：
- 在 Cloud 控制台 中，进入 Integration Connectors > 连接页面，然后选择或创建一个 Google Cloud 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中，选择连接的位置。
- 区域：从下拉列表中选择一个位置。
如需查看所有受支持区域的列表，请参阅位置。
- 点击下一步。
- 区域：从下拉列表中选择一个位置。
- 在连接详情部分中，完成以下操作：
- 连接器：从可用连接器的下拉列表中选择 FTP。
- 连接器版本：从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中，输入连接实例的名称。
连接名称必须符合以下条件：
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头，以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- （可选）输入连接实例的说明。
- 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为
Error。 - 服务账号：选择具有所需角色的服务账号。
- （可选）配置连接节点设置：
- 节点数下限：输入连接节点数下限。
- 节点数上限：输入连接节点数上限。
节点是处理事务的连接单元（或副本）。 连接处理越多事务就需要越多节点，相反，处理越少事务需要越少节点。 如需了解节点如何影响连接器价格，请参阅连接节点的价格。如果未输入任何值，则默认情况下，节点数下限设置为 2（以便提高可用性），节点数上限设置为 50。
- 文件检索深度：指定要从 Root 表中查询的文件夹的深度级别。
- 被动：控制是否将服务器定向到被动模式。建议在防火墙后使用。
- 远程路径：FTP 服务器中的当前路径。
- SSL 模式：连接到 FTP 服务器时使用的身份验证机制。
- 表深度：将子文件夹显示为视图的深度级别。
- 使用 MLSD：使用列表进行机器处理。仅用于 FTP 服务器。
- （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
- 点击下一步。
- 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
- 目标类型：选择目标类型。
- 如需指定目标主机名或 IP 地址，请选择主机地址，然后在主机 1 字段中输入相应地址。
- 如需建立专用连接，请选择端点连接。在端点连接列表中，选择为后端系统创建的端点连接。
如果要与后端系统建立公共连接以提高安全性，您可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
若要输入其他目标，请点击 + 添加目标。
- 点击下一步。
- 目标类型：选择目标类型。
-
在身份验证部分中，输入身份验证详细信息。
- 选择身份验证类型，然后输入相关详细信息。
FTP 连接支持以下身份验证类型：
- 用户名和密码
- 点击下一步。
如需了解如何配置这些身份验证类型，请参阅配置身份验证。
- 选择身份验证类型，然后输入相关详细信息。
- 查看：查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
用户名和密码
- 用户名：用于连接的 FTP 用户名。
- 密码：包含与 FTP 用户名关联的密码的 Secret Manager Secret。
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体：实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如，在数据库连接器中，表是实体；在文件服务器连接器中，文件夹是实体；在消息传递系统连接器中，队列是实体。
但可能的情况是，连接器不支持或不具有任何实体，在这种情况下，
Entities列表将为空。 - 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
从可用列表中选择一个实体，系统会生成该实体可用的操作列表。如需了解操作的详细说明，请参阅连接器任务的实体操作。不过，如果连接器不支持任何实体操作，则不支持的操作不会列在
Operations列表中。 - 动作：动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改，并且动作因连接器而异。通常，操作会包含一些输入参数和一个输出参数。但可能的情况是，连接器不支持任何动作，在这种情况下，
Actions列表将为空。
系统限制
FTP 连接器每秒每个节点可处理 1 个事务，并会限制超出此限额的任何事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。
如需了解适用于 Integration Connectors 的限制，请参阅限制。
操作
本部分列出了连接器支持的部分操作。如需了解如何配置操作，请参阅操作示例。
上传操作
下表介绍了 Upload 操作的输入参数。
| 参数名称 | 数据类型 | 必需 | 说明 |
|---|---|---|---|
| 内容 | 字符串 | 否 | 要以文件形式上传的内容。 |
| ContentBytes | 字符串 | 否 | 要上传为文件的字节内容（以 Base64 字符串形式表示）。使用此方法上传二进制数据。 |
| HasBytes | 布尔值 | 否 | 指定内容是否应以字节形式上传。默认值为 false。 |
| RemoteFile | 字符串 | 是 | 远程主机上的文件名。 |
| 覆盖 | 布尔值 | 否 | 指定是否应覆盖远程文件。默认值为 false。 |
如需查看有关如何配置 Upload 操作的示例，请参阅示例。
下载操作
下表介绍了 Download 操作的输入参数。
| 参数名称 | 数据类型 | 必需 | 说明 |
|---|---|---|---|
| RemoteFile | 字符串 | 是 | 远程主机上的文件名。 |
| HasBytes | 布尔值 | 否 | 指定内容是否应以字节形式下载。默认值为 false。 |
如需查看有关如何配置 Download 操作的示例，请参阅示例。
MoveFile 操作
下表介绍了 MoveFile 操作的输入参数。
| 参数名称 | 数据类型 | 必需 | 说明 |
|---|---|---|---|
| RemoteFile | 字符串 | 是 | 要移动的远程文件的路径。 |
| DestinationPath | 字符串 | 是 | 您要将文件移到的新路径。 |
如需查看有关如何配置 MoveFile 操作的示例，请参阅示例。
RenameFile 操作
下表介绍了 RenameFile 操作的输入参数。
| 参数名称 | 数据类型 | 必需 | 说明 |
|---|---|---|---|
| RemoteFile | 字符串 | 是 | 要重命名的远程文件路径和名称。 |
| NewFileName | 字符串 | 是 | 远程文件的新名称。 |
如需查看有关如何配置 RenameFile 操作的示例，请参阅示例。
示例
本部分介绍如何在此连接器中执行一些实体操作和动作。这些示例描述了以下操作：
- 列出根目录中的所有文件：
- 列出与目录中的模式匹配的文件
- 移动文件
- 重命名文件
- 删除文件
- 上传 ASCII 文本文件
- 上传二进制文件
- 下载 ASCII 文本文件
- 下载二进制文件
下表列出了连接器任务中的示例场景和相应的配置：
| 任务 | 示例命令 | 配置 |
|---|---|---|
| 列出根目录中的所有文件： | ls / |
|
列出目录中的 .csv 文件 |
ls /tmp/*.csv |
|
| 移动文件 | mv /tmp/dir_A/hello_world.txt /dir_B/dir_C/ |
此示例将 [{ "Success":"true" }] |
| 重命名文件 | mv /tmp/hello_world.txt /tmp/hello_world_new.txt |
此示例将 [{ "Success":"true" }] |
| 删除文件 | rm /tmp/myfile.csv |
|
| 上传 ASCII 文本文件 | put file_1.txt /tmp/file_1.txt |
此示例会创建一个 设置 |
| 上传二进制文件 | put image_1.png /tmp/image_1.png |
如需上传二进制内容，您必须先以 Base64 格式对内容进行编码。您可以选择一个工具来对内容进行编码。对内容进行编码的步骤不在本文档的讨论范围内。具有 Base64 字符串内容后，请执行以下步骤：
此示例使用 设置 |
| 下载 ASCII 文本文件 | get /tmp/myfile.txt |
下载文件的内容以字符串形式显示在连接器任务的 |
| 下载二进制文件 | get /tmp/myfile.png |
您可以在连接器任务的 |
载荷的 JSON 架构
FTP 连接中的所有实体对象都具有预定义的 JSON 架构。充分了解架构后，您可以轻松配置输入或输出载荷值。FTP 连接中的实体对象使用以下 JSON 架构：
{ "type": "object", "properties": { "FilePath": { "type": "string", "readOnly": false }, "Filename": { "type": [ "string", "null" ], "readOnly": false, "description": "The name of the file or directory." }, "FileSize": { "type": [ "number", "null" ], "readOnly": false, "description": "The size of the file." }, "LastModified": { "type": [ "string", "null" ], "readOnly": false }, "IsDirectory": { "type": [ "boolean", "null" ], "readOnly": false }, "Permissions": { "type": [ "string", "null" ], "readOnly": false }, "Owner": { "type": [ "string", "null" ], "readOnly": false }, "OwnerId": { "type": [ "string", "null" ], "readOnly": false }, "Group": { "type": [ "string", "null" ], "readOnly": false }, "GroupId": { "type": [ "string", "null" ], "readOnly": false } } }
filterClause 的动态配置
对于列出、更新和删除操作，您可以使用集成中的数据映射任务，动态设置 filterClasue 输入变量的值。例如，不妨在集成中调用 API 触发器时发送过滤条件子句的值。下图显示了数据映射任务的数据映射编辑器中 filterClause 变量的示例映射：
使用 Terraform 创建连接
您可以使用 Terraform 资源创建新连接。
如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。
如需查看用于创建连接的 Terraform 模板示例，请参阅模板示例。
使用 Terraform 创建此连接时，您必须在 Terraform 配置文件中设置以下变量：
| 参数名称 | 数据类型 | 必需 | 说明 |
|---|---|---|---|
| file_retrieval_depth | STRING | 错误 | 指定要从 Root 表中查询的文件夹的深度级别。 |
| 被动 | BOOLEAN | 错误 | 控制是否将服务器定向到被动模式。建议在防火墙后使用。 |
| remote_path | STRING | 错误 | FTP 服务器中的当前路径。 |
| table_depth | INTEGER | 错误 | 将子文件夹显示为视图的深度级别。 |
| use_mlsd | BOOLEAN | 错误 | 使用列表进行机器处理。仅用于 FTP 服务器。 |
在集成中使用 FTP 连接
创建连接后，该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。
- 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
- 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。