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

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Sources

创建对象：

Developer

基本连接表示源和Adobe Experience Platform之间经过身份验证的连接。

本教程将指导您完成创建基本连接的步骤。 Amazon S3 (以下简称“ ”S3")使用 Flow Service API.

快速入门

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

源： Experience Platform 允许从各种源摄取数据，同时让您能够使用以下方式构建、标记和增强传入数据： Platform 服务。
沙盒： Experience Platform 提供对单个进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中，以帮助开发和改进数字体验应用程序。

以下部分提供成功连接到 S3 存储使用 Flow Service API。

收集所需的凭据

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

凭据

描述

s3AccessKey

您的用户的访问密钥ID 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 文档.

使用平台API

有关如何成功调用Platform API的信息，请参阅 Platform API快速入门.

创建基本连接

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

POST要创建基本连接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 源。

更新您的 S3 会话令牌

此 s3SessionToken 是临时的，并且必须在过期时更新。您可以通过向发出PATCH请求来更新与您的基本连接关联的会话令牌 Flow Service API。请参阅 S3 概述有关以下项的临时安全证书的详细信息： S3.

IMPORTANT

此 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和更新的etag。您可以通过向以下用户发出GET请求来验证更新： Flow Service API，同时提供您的连接ID。

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

recommendation-more-help

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