配置文件系统作业端点(删除请求)

Adobe Experience Platform允许您从多个源摄取数据,并为各个客户构建可靠的配置文件。 摄取到 Platform 存储在 Data Lake,并且如果为用户档案启用了数据集,则该数据存储在 Real-time Customer Profile 数据存储。 有时可能需要从配置文件存储中删除数据集或批量处理,才能删除不再需要或错误添加的数据。 这需要使用 Real-time Customer Profile 用于创建 Profile 系统作业,或 delete request,也可以根据需要修改、监视或删除。

注意

如果您尝试从 Data Lake,请访问 目录服务概述 以了解更多信息。

快速入门

本指南中使用的API端点是 Real-time Customer Profile API. 在继续之前,请查看 入门指南 有关相关文档的链接,请参阅本文档中的API调用示例指南,以及有关成功调用任何Experience PlatformAPI所需标头的重要信息。

查看删除请求

删除请求是一个长时间运行的异步过程,这意味着您的组织可能同时运行多个删除请求。 为了查看您的组织当前正在运行的所有删除请求,您可以向 /system/jobs 端点。

您还可以使用可选查询参数来筛选响应中返回的删除请求列表。 要使用多个参数,请使用与号(&)。

API格式

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
参数 描述
start 根据请求的创建时间,偏移返回的结果页面。 示例: start=4
limit 限制返回的结果数。 示例: limit=10
page 根据请求的创建时间返回特定的结果页面。 示例: page=2
sort 按特定字段对结果进行升序排序(asc)或降序(desc)顺序。 返回多个结果页面时,排序参数不起作用。 示例: sort=batchId:asc

请求

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -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}' \

响应

响应包括一个“子”数组,其中每个删除请求的对象都包含该请求的详细信息。

{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{ORG_ID}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{ORG_ID}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}
属性 描述
_page.count 请求总数。 此响应已因空间而被截断。
_page.next 如果存在其他的结果页,请通过将 查找请求"next" 值。
jobType 要创建的作业的类型。 在这种情况下,它将始终返回 "DELETE".
status 删除请求的状态。 可能的值为 "NEW", "PROCESSING", "COMPLETED", "ERROR".
metrics 包含已处理记录数("recordsProcessed")以及请求正在处理的时间(以秒为单位),或请求完成所用的时间("timeTakenInSec")。

创建删除请求

通过向 /systems/jobs 端点,其中要删除的数据集或批处理的ID在请求正文中提供。

删除数据集

要从用户档案存储中删除数据集,数据集ID必须包含在POST请求的正文中。 此操作将删除给定数据集的所有数据。 Experience Platform 允许您根据记录架构和时间系列架构删除数据集。

API格式

POST /system/jobs

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -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}' \
  -d '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'
属性 描述
dataSetId (必需) 要删除的数据集的ID。

响应

成功的响应会返回新创建的删除请求的详细信息,包括请求的唯一、系统生成的只读ID。 这可用于查找请求并检查其状态。 的 status 在创建时请求为 "NEW" 直到它开始处理。 的 dataSetId 响应中应与 dataSetId 发送。

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{ORG_ID}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}
属性 描述
id 删除请求的唯一、系统生成的只读ID。
dataSetId 数据集的ID,在POST请求中指定。

删除批处理

要删除批处理,批处理ID必须包含在POST请求的正文中。 请注意,您无法删除基于记录架构的数据集的批次。 只能删除基于时间序列架构的数据集的批量。

注意

无法删除基于记录架构的数据集批次的原因是,记录类型数据集批次会覆盖以前的记录,因此无法“撤消”或删除这些批次。 消除基于记录架构的数据集错误批次影响的唯一方法是,使用正确的数据重新摄取批次,以覆盖错误的记录。

有关记录和时间序列行为的详细信息,请查看 关于XDM数据行为的章节 在 XDM System 概述。

API格式

POST /system/jobs

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -H 'Content-Type: application/json' \
  -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}' \
  -d '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'
属性 描述
batchId (必需) 要删除的批次的ID。

响应

成功的响应会返回新创建的删除请求的详细信息,包括请求的唯一、系统生成的只读ID。 这可用于查找请求并检查其状态。 的 "status" 在创建时请求为 "NEW" 直到它开始处理。 的 "batchId" 响应中的值应与 "batchId" 值。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}
属性 描述
id 删除请求的唯一、系统生成的只读ID。
batchId 批次的ID,在POST请求中指定。

如果尝试为记录数据集批次启动删除请求,则会遇到400级错误,如下所示:

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

查看特定删除请求

要查看特定的删除请求(包括其状态等详细信息),您可以对 /system/jobs 端点,并在路径中包含删除请求的ID。

API格式

GET /system/jobs/{DELETE_REQUEST_ID}
参数 描述
{DELETE_REQUEST_ID} (必需) 您希望查看的删除请求的ID。

请求

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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}' \

响应

响应会提供删除请求的详细信息,包括其更新状态。 响应中删除请求的ID( "id" 值)应匹配请求路径中发送的ID。

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}
属性 描述
jobType 要创建的作业类型,在这种情况下将始终返回 "DELETE".
status 删除请求的状态。 可能值: "NEW", "PROCESSING", "COMPLETED", "ERROR".
metrics 一个数组,其中包含已处理的记录数("recordsProcessed")以及请求正在处理的时间(以秒为单位),或请求完成所用的时间("timeTakenInSec")。

删除请求状态为 "COMPLETED" 您可以通过尝试使用数据访问API访问已删除的数据来确认该数据已删除。 有关如何使用数据访问API访问数据集和批量数据的说明,请查看 数据访问文档.

删除请求

Experience Platform 允许您删除以前的请求,这可能由于多种原因(包括删除作业未完成或在处理阶段卡住)而有用。 要删除DELETE请求,您可以对 /system/jobs 端点,并包括您要将其删除到请求路径的删除请求的ID。

API格式

DELETE /system/jobs/{DELETE_REQUEST_ID}
参数 描述
要删除的删除请求的ID。

请求

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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}' \

响应

成功的删除请求会返回HTTP状态200(确定)和空的响应正文。 您可以通过执行GET请求以按其ID查看删除请求,确认该请求已删除。 这应会返回HTTP状态404(未找到),指示删除请求已被删除。

后续步骤

现在,您已了解从 Profile Store within Experience Platform,则可以安全地删除错误添加或贵组织不再需要的数据。 请注意,删除请求无法撤消,因此您应该只删除您确信现在不需要且将来不需要的数据。

在此页面上