使用Flow Service API为按需引入创建流运行

Last update: Wed Jul 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：

创建对象：

开发人员

流运行表示流执行的实例。例如，如果某个流计划在上午9:00、上午10:00和上午11:00每小时运行，则您将运行该流的三个实例。流量运行特定于您的特定组织。

按需引入允许您针对给定数据流创建流运行。这允许您的用户基于给定的参数创建流运行并创建引入周期，而不使用服务令牌。仅对批来源提供按需摄取支持。

本教程介绍了有关如何使用按需引入和使用Flow Service API创建流运行的步骤。

快速入门

NOTE

要创建流运行，您必须首先具有计划为一次性摄取的数据流的流ID。

本教程要求您实际了解Adobe Experience Platform的以下组件：

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

使用平台API

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

为基于表的源创建流运行

要为基于表的源创建流，请向Flow Service API发出POST请求，同时提供要创建运行的流的ID以及开始时间、结束时间和增量列的值。

TIP

基于表的源包括以下源类别：广告、分析、同意和偏好设置、CRM、客户成功、数据库、营销自动化、支付和协议。

API格式

POST /runs/

请求

以下请求为流ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de创建流运行。

NOTE

您只需在创建首次流运行时提供deltaColumn。之后，deltaColumn将作为流中copy转换的一部分进行修补，并将被视为真实来源。任何试图通过流运行参数更改deltaColumn值的尝试都将导致错误。

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/runs' \
  -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 '{
      "flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
      "params": {
          "startTime": "1663735590",
          "windowStartTime": "1651584991",
          "windowEndTime": "16515859567",
          "deltaColumn": {
              "name": "DOB"
          }
      }
  }'

参数

描述

flowId

将创建流运行时所针对的流的ID。

params.startTime

按需流运行的计划开始时间。此值以unix时间表示。

params.windowStartTime

从中检索数据的最早日期和时间。此值以unix时间表示。

params.windowEndTime

检索数据的日期和时间。此值以unix时间表示。

params.deltaColumn

需要对数据进行分区并将新摄取的数据与历史数据进行分离。注意：仅在创建您的第一个流运行时需要deltaColumn。

params.deltaColumn.name

增量列的名称。

响应

成功的响应返回新创建的流运行的详细信息，包括其唯一运行id。

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}

属性

描述

id

新创建的流运行的ID。有关基于表的运行规范的详细信息，请参阅检索流规范指南。

etag

流运行的资源版本。

为基于文件的源创建流运行

要为基于文件的源创建流，请向Flow Service API发出POST请求，同时提供要创建运行的流的ID以及开始时间和结束时间的值。

TIP

基于文件的源包括所有云存储源。