使用Flow Service API创建Amazon S3基本连接

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

开发人员

基本连接表示源和Adobe Experience Platform之间的已验证连接。

本教程将指导您完成使用Flow Service API为Amazon S3（以下称为“S3”）创建基础连接的步骤。

快速入门

本指南要求您对 Adobe Experience Platform 的以下组件有一定了解：

源： Experience Platform允许从各种源摄取数据，同时允许您使用Platform服务来构建、标记和增强传入数据。
沙盒： Experience Platform提供将单个Platform实例划分为单独虚拟环境的虚拟沙盒，以帮助开发和改进数字体验应用程序。

以下部分提供了使用Flow Service API成功连接到S3存储所需的其他信息。

收集所需的凭据

为了使Flow Service连接到S3存储，您必须提供以下连接属性的值：

凭据

描述

s3AccessKey

S3存储段的访问密钥ID。

s3SecretKey

S3存储段的密钥ID。

serviceUrl

（可选）要连接的自定义S3端点。当您的S3存储段特定于区域时，此字段必填。 serviceUrl的格式为： https://s3.{REGION}.amazonaws.com/)。

bucketName

S3存储段包含您的数据及其相应的描述性元数据。您的S3存储段名称长度必须介于3到63个字符之间，且必须以字母或数字开头和结尾。存储段名称只能包含小写字母、数字或连字符(-)，并且不能格式化为IP地址。

folderPath

S3存储段中存储数据的文件夹的路径。当用户访问受限时，需要此凭据。

s3SessionToken

（可选）一个短期的临时令牌，允许您向不受信任环境中的用户提供对S3资源的临时访问。有关详细信息，请参阅S3 概述。

connectionSpec.id

连接规范返回源的连接器属性，包括与创建基础连接和源连接相关的验证规范。 S3的连接规范ID为： ecadc60c-7455-4d87-84dc-2a0e293d997b。

有关入门的详细信息，请访问此 Amazon Web Services 文档。

使用平台API

有关如何成功调用平台API的信息，请参阅平台API快速入门指南。

创建基本连接

基本连接会保留您的源和平台之间的信息，包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。基本连接ID允许您浏览和浏览源中的文件，并标识要摄取的特定项目，包括有关其数据类型和格式的信息。

要创建基本连接ID，请在提供S3身份验证凭据作为POST参数的一部分时，向/connections端点请求请求。

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源的其他信息。

更新您的S3会话令牌

s3SessionToken是临时的，过期时必须更新。您可以通过向Flow Service API发出PATCH请求来更新与您的基本连接关联的会话令牌。有关S3临时安全凭据的更多信息，请参阅S3 概述。

IMPORTANT

发出PATCH请求时需要If-Match标头。此标头的值是您要更新的连接的唯一电子标记。

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和更新的电子标记。您可以在提供连接ID的同时向Flow Service API发出GET请求，以验证更新。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089