基本连接表示源与Adobe Experience Platform之间经过验证的连接。
本教程将指导您完成为 Amazon S3 (以下简称“S3“)使用 Flow Service API.
本指南要求您对Adobe Experience Platform的以下组件有一定的了解:
以下部分提供了成功连接到 S3 存储 Flow Service API。
为 Flow Service 与 S3 存储中,必须为以下连接属性提供值:
凭据 | 描述 |
---|---|
s3AccessKey |
您的 S3 存储段。 |
s3SecretKey |
您的密钥ID S3 存储段。 |
serviceUrl |
(可选)自定义 S3 要连接到的端点。 当您的 S3 存储段特定于区域。 的格式 serviceUrl 为: https://s3.{REGION}.amazonaws.com/) . |
bucketName |
的 S3 存储段包含您的数据及其相应的描述性元数据。 您的 S3 存储段名称必须长3到63个字符,且必须以字母或数字开头和结尾。 存储段名称只能包含小写字母、数字或连字符(- ),且无法格式化为IP地址。 |
folderPath |
您的 S3 存储数据的存储段。 当用户具有受限访问权限时,需要此凭据。 |
s3SessionToken |
(可选)允许您提供对 S3 资源。 请参阅 S3 概述 以了解更多信息。 |
connectionSpec.id |
连接规范返回源的连接器属性,包括与创建基连接和源连接相关的验证规范。 的连接规范ID S3 为: ecadc60c-7455-4d87-84dc-2a0e293d997b . |
有关入门的更多信息,请访问 此 Amazon Web Services 文档.
有关如何成功调用Platform API的信息,请参阅 Platform API快速入门.
基本连接保留了源和平台之间的信息,包括源的身份验证凭据、连接的当前状态和唯一基本连接ID。 基本连接ID允许您从源中浏览和导航文件,并标识要摄取的特定项目,包括有关其数据类型和格式的信息。
要创建基本连接ID,请向 /connections
提供 S3 身份验证凭据作为请求参数的一部分。
API格式
POST /connections
请求
以下请求会为 S3:
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": "Amazon S3 base connection",
"description": "Amazon S3 base connection with temporary session token",
"auth": {
"specName": "Access Key",
"params": {
"s3AccessKey": "{S3_ACCESS_KEY}",
"s3SecretKey": "{S3_SECRET_KEY}",
"s3SessionToken": "{S3_SESSION_TOKEN}
}
},
"connectionSpec": {
"id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
"version": "1.0"
}
}'
属性 | 描述 |
---|---|
auth.params.s3AccessKey |
与 S3 存储段。 |
auth.params.s3SecretKey |
您与 S3 存储段。 |
auth.params.s3SessionToken |
(可选)短期、临时 S3 用于访问存储段的令牌。 |
connectionSpec.id |
的 S3 连接规范ID: ecadc60c-7455-4d87-84dc-2a0e293d997b |
响应
成功的响应会返回新创建连接的详细信息,包括其唯一标识符(id
)。 在下一个教程中探索您的存储需要此ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}
在本教程之后,您已使用API创建了S3连接,并且在响应主体中获取了唯一ID。 您可以将此连接ID用于 使用流量服务API浏览云存储.
以下部分提供了有关使用 S3 来源。
的 s3SessionToken
为临时的,且必须在过期时进行更新。 您可以通过向发出PATCH请求来更新与基本连接关联的会话令牌 Flow Service API。 请参阅 S3 概述 有关临时安全凭据的详细信息,请参阅 S3.
的 If-Match
发出PATCH请求时需要标头。 此标头的值是要更新的连接的唯一标头。
API格式
PATCH /connections
请求
以下请求会为 S3:
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
-d '[
{
"op": "replace",
"path": "/auth/params/s3SessionToken",
"value": "{SESSION_TOKEN}"
}
]'
参数 | 描述 |
---|---|
op |
操作调用,用于定义更新连接所需的操作。 操作包括: add , replace 和 remove . |
path |
要更新的参数的路径。 |
value |
要使用更新参数的新值。 |
响应
成功的响应会返回您的基本连接ID和更新的标记。 您可以通过向 Flow Service API,同时提供连接ID。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}