Ultimate

创建 Amazon Kinesis 使用流服务API的源连接

上次更新: 2023-11-14
  • 主题:
  • Sources
    查看有关此主题的更多信息
  • 创建对象:
  • Developer
    User
    Admin
    Leader
重要

此 Amazon Kinesis 源目录中的源可供已购买Real-time Customer Data Platform Ultimate的用户使用。

本教程将指导您完成连接的步骤 Amazon Kinesis (以下简称“Kinesis“)Experience Platform,使用 Flow Service API.

快速入门

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

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

以下部分提供成功连接时需要了解的其他信息 Kinesis 到平台,使用 Flow Service API。

收集所需的凭据

为了 Flow Service 以与您的 Amazon Kinesis 帐户,您必须提供以下连接属性的值:

凭据 描述
accessKeyId 访问密钥ID是用来验证您的身份的访问密钥对的一半。 Kinesis Platform帐户。
secretKey 访问密钥是访问密钥对的另一半,用于验证您的 Kinesis Platform帐户。
region 您的地区 Kinesis 帐户。 请参阅指南,网址为 将IP地址添加到允许列表 以了解有关地区的更多信息。
connectionSpec.id 连接规范返回源的连接器属性,包括与创建基础连接和源连接相关的验证规范。 此 Kinesis 连接规范ID为: 86043421-563b-46ec-8e6c-e23184711bf6.

有关的详细信息 Kinesis 访问密钥以及如何生成它们,请参阅此 AWS 管理IAM用户的访问密钥指南.

使用平台API

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

创建基本连接

创建源连接的第一步是验证您的 Kinesis 并生成基本连接ID。 基本连接ID允许您浏览和浏览源中的文件,并识别要摄取的特定项目,包括有关其数据类型和格式的信息。

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

API格式

POST /connections

请求

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 Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region": "{REGION}"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.accessKeyId 您的访问密钥ID Kinesis 帐户。
auth.params.secretKey 您的访问密钥 Kinesis 帐户。
auth.params.region 您的地区 Kinesis 帐户。
connectionSpec.id 此 Kinesis 连接规范ID: 86043421-563b-46ec-8e6c-e23184711bf6

响应

成功的响应会返回新创建的基本连接的详细信息,包括其唯一标识符(id)。 在下一步创建源连接时需要此ID。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

创建源连接

源连接创建和管理与摄取数据的外部源的连接。 源连接由数据源、数据格式和创建数据流所需的源连接ID等信息组成。 源连接实例特定于租户和组织。

POST要创建源连接,请向 /sourceConnections 的端点 Flow Service API。

API格式

POST /sourceConnections

请求

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "AWS Kinesis source connection",
        "description": "A source connection for AWS Kinesis",
        "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "stream": "{STREAM}",
            "dataType": "raw",
            "reset": "latest"
        }
    }'
属性 描述
name 源连接的名称。 请确保源连接的名称是描述性的,因为您可以使用此名称查找有关源连接的信息。
description 可提供的可选值,用于包含有关源连接的更多信息。
baseConnectionId 您的的基本连接ID Kinesis 上一步中生成的源。
connectionSpec.id 的固定连接规范ID Kinesis. 此ID为: 86043421-563b-46ec-8e6c-e23184711bf6
data.format 的格式 Kinesis 要摄取的数据。 目前,唯一支持的数据格式为 json.
params.stream 要从中提取记录的数据流的名称。
params.dataType 此参数定义正在摄取的数据的类型。 支持的数据类型包括: rawxdm.
params.reset 此参数定义数据的读取方式。 使用 latest 以开始读取最新数据,并使用 earliest 以开始读取流中的第一个可用数据。

响应

成功的响应将返回唯一标识符(id)。 在下一个教程中,创建数据流时需要此ID。

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

后续步骤

在本教程之后,您已创建一个 Kinesis 源连接使用 Flow Service API。 您可以在下一教程中使用此源连接ID 使用创建流数据流 Flow Service API.

在此页面上