基本连接表示源与Adobe Experience Platform之间经过验证的连接。
本教程将指导您完成为 SFTP (安全文件传输协议)使用 Flow Service API.
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
在使用 SFTP 源连接。 要绕过限制,请每行使用一个JSON对象,并使用多行来生成后续文件。
以下部分提供了成功连接到 SFTP 服务器使用 Flow Service API。
为 Flow Service 连接到 SFTP,则必须为以下连接属性提供值:
凭据 | 描述 |
---|---|
host |
与您的 SFTP 服务器。 |
port |
您连接到的SFTP服务器端口。 如果未提供,则值默认为 22 . |
username |
有权访问您的 SFTP 服务器。 |
password |
您的密码 SFTP 服务器。 |
privateKeyContent |
Base64编码的SSH私钥内容。 OpenSSH密钥的类型必须分类为RSA或DSA。 |
passPhrase |
如果密钥文件或密钥内容受密码短语的保护,则解密私钥的密码短语或密码。 如果 privateKeyContent 受密码保护,此参数需要与私钥内容的密码短语一起用作值。 |
connectionSpec.id |
连接规范返回源的连接器属性,包括与创建基连接和源连接相关的验证规范。 的连接规范ID SFTP 为: b7bf2577-4520-42c9-bae9-cad01560f7bc . |
有关如何成功调用Platform API的信息,请参阅 Platform API快速入门.
基本连接保留了源和平台之间的信息,包括源的身份验证凭据、连接的当前状态和唯一基本连接ID。 基本连接ID允许您从源中浏览和导航文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接ID,请向 /connections
提供 SFTP 身份验证凭据作为请求参数的一部分。
创建 SFTP 基本连接使用基本身份验证,向POST请求 Flow Service API,同时为连接的 host
, userName
和 password
.
API格式
POST /connections
请求
以下请求会为 SFTP 使用基本身份验证:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SFTP connector with password",
"description": "SFTP connector password",
"auth": {
"specName": "Basic Authentication for sftp",
"params": {
"host": "{HOST}",
"userName": "{USERNAME}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
属性 | 描述 |
---|---|
auth.params.host |
SFTP服务器的主机名。 |
auth.params.username |
与SFTP服务器关联的用户名。 |
auth.params.password |
与SFTP服务器关联的密码。 |
connectionSpec.id |
SFTP服务器连接规范ID: b7bf2577-4520-42c9-bae9-cad01560f7bc |
响应
成功的响应会返回唯一标识符(id
)。 在下一个教程中,浏览SFTP服务器时需要此ID。
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
创建 SFTP 基本连接使用SSH公钥身份验证,向发出POST请求 Flow Service API,同时为连接的 host
, userName
, privateKeyContent
和 passPhrase
.
的 SFTP 连接器支持RSA或DSA类型OpenSSH密钥。 确保关键文件内容以 "-----BEGIN [RSA/DSA] PRIVATE KEY-----"
结尾为 "-----END [RSA/DSA] PRIVATE KEY-----"
. 如果私钥文件是PPK格式的文件,请使用PuTTY工具将PPK格式转换为OpenSSH格式。
API格式
POST /connections
请求
以下请求会为 SFTP 使用SSH公钥身份验证:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SFTP connector with SSH authentication",
"description": "SFTP connector with SSH authentication",
"auth": {
"specName": "SSH PublicKey Authentication for sftp",
"params": {
"host": "{HOST}",
"userName": "{USERNAME}",
"privateKeyContent": "{PRIVATE_KEY_CONTENT}",
"passPhrase": "{PASSPHRASE}"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
属性 | 描述 |
---|---|
auth.params.host |
的主机名 SFTP 服务器。 |
auth.params.username |
与您的 SFTP 服务器。 |
auth.params.privateKeyContent |
Base64编码的SSH私钥内容。 OpenSSH密钥的类型必须分类为RSA或DSA。 |
auth.params.passPhrase |
如果密钥文件或密钥内容受密码短语的保护,则解密私钥的密码短语或密码。 如果PrivateKeyContent受密码保护,则此参数需要与PrivateKeyContent的密码短语一起用作值。 |
connectionSpec.id |
的 SFTP 服务器连接规范ID: b7bf2577-4520-42c9-bae9-cad01560f7bc |
响应
成功的响应会返回唯一标识符(id
)。 需要此ID才能浏览您的 SFTP 服务器。
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
通过阅读本教程,您已创建 SFTP 使用 Flow Service API,并且已获取连接的唯一ID值。 您可以将此连接ID用于 使用流量服务API浏览云存储.