Show Menu
主题×

用户档案系统作业端点(删除请求)

Adobe Experience Platform使您能够从多个来源收集数据,并为各个客户构建强大的用户档案。 引入平台的数据存储在数据湖和实时客户用户档案数据存储中。 有时可能需要从用户档案库中删除数据集或批处理,以删除不再需要或错误添加的数据。 这需要使用实时用户档案API创建用户档案系统作业(也称为“删除请求”),如果需要,也可以修改、监视或删除该作业。
如果您尝试从数据湖中删除数据集或批,请访问目录 服务概述 ,以获取说明。

入门指南

本指南中使用的API端点是实 时客户用户档案API的一部分 。 在继续之前,请查 看入门指南 ,了解相关文档的链接、阅读此文档中示例API调用的指南,以及成功调用任何Experience PlatformAPI所需标头的重要信息。

视图删除请求

删除请求是一个长时间运行的异步进程,这意味着您的组织可能同时运行多个删除请求。 为了视图您的单位当前正在运行的所有删除请求,您可以对端点执行GET请 /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 POST \
  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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应
该响应包括一个“子项”数组,每个删除请求都有一个对象,其中包含该请求的详细信息。
{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{IMS_ORG}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{IMS_ORG}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}

属性
描述
_page.count
请求总数。 此响应已被截断为空间。
_page.next
如果存在其他结果页,则通过将查找请求中的ID值替换为提供的值来视图 下一页 "next" 的结果。
jobType
所创建作业的类型。 在这种情况下,它将始终返回 "DELETE"
status
删除请求的状态。 可能的 "NEW" 值为 "PROCESSING" "COMPLETED" "ERROR"
metrics
一个对象,包括已处理的记录数( "recordsProcessed" )和请求已处理的时间(秒),或完成请求所用的时间( "timeTakenInSec" )。

创建删除请求

通过对端点的POST请求启动新的删除请 /systems/jobs 求,其中,要删除的数据集或批的ID在请求主体中提供。

删除数据集

要删除数据集,数据集ID必须包含在POST请求的正文中。 此操作将删除给定数据集的ALL数据。 Experience Platform允许您根据记录和时间序列模式删除数据集。
当尝试使用用户档案UI删除启用Experience Platform的数据集时,将禁用该数据集以进行摄取,但直到使用API创建删除请求后,才会删除该数据集。 有关详细信息,请参 阅本文档 的附录。
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'

属性
描述
dataSetId
(必需 )要删除的数据集的ID。
响应
成功的响应会返回新创建的删除请求的详细信息,包括该请求的唯一、由系统生成的只读ID。 这可用于查找请求并检查其状态。 创 status 建时请求在开始处理 "NEW" 之前一直有效。 响 dataSetId 应中的值应与请求 dataSetId 中发送的值匹配。
{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{IMS_ORG}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}

属性
描述
id
删除请求的唯一、由系统生成的只读ID。
dataSetId
数据集的ID,在POST请求中指定。

删除批

要删除批,批ID必须包含在POST请求的正文中。 请注意,不能根据记录模式删除数据集的批。 只能删除基于时间序列模式的数据集的批次。
无法根据记录模式删除数据集批的原因是记录类型数据集批覆盖以前的记录,因此无法“撤消”或删除。 要消除基于记录模式的数据集中错误批次的影响,唯一的方法是使用正确的数据重新收录批次,以覆盖错误的记录。
有关记录和时间序列行为的详细信息,请查看XDM 系统概述中有关XDM 数据行为的一节。
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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'

属性
描述
batchId
(必需 )要删除的批的ID。
响应
成功的响应会返回新创建的删除请求的详细信息,包括该请求的唯一、由系统生成的只读ID。 这可用于查找请求并检查其状态。 创 "status" 建时请求在开始处理 "NEW" 之前一直有效。 响 "batchId" 应中的值应与请求 "batchId" 中发送的值匹配。
{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "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'"
            }
        ]
    }
}

视图特定删除请求

要视图特定的删除请求(包括其状态等详细信息),您可以对端点执行查找(GET)请求 /system/jobs ,并将删除请求的ID包括在路径中。
API格式
GET /system/jobs/{DELETE_REQUEST_ID}

参数
描述
{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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应
响应提供删除请求的详细信息,包括其更新状态。 响应中删除请求的ID应与请求路径中发送的ID匹配。
{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}

属性
描述
jobType
所创建作业的类型,在此情况下,它将始终返回 "DELETE"
status
删除请求的状态。 Possible values: "NEW" , "PROCESSING" , "COMPLETED" , "ERROR" .
metrics
一个数组,包括已处理的记录数( "recordsProcessed" )和请求已处理的时间(秒),或完成请求所用的时间( "timeTakenInSec" )。
删除请求状态一旦 "COMPLETED" 生效,您就可以通过尝试使用数据访问API访问已删除的数据来确认该数据已被删除。 有关如何使用Data Access API访问数据集和批次的说明,请查阅Data Access 文档

删除删除请求

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

参数
描述
{DELETE_请求_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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

响应
成功删除请求将返回HTTP状态200(OK)和空的响应主体。 您可以通过执行GET请求来按删除请求的ID视图该请求,以确认该请求已被删除。 这应返回“HTTP状态404(未找到)”,表示删除请求已被删除。

后续步骤

现在,您已了解从Experience Platform内的用户档案商店删除数据集和批处理时涉及的步骤,因此您可以安全地删除错误添加的数据或组织不再需要的数据。 请注意,删除请求无法撤消,因此您应仅删除您确信现在不需要且将来不需要的数据。

附录

以下信息是从用户档案库删除数据集操作的补充。

使用Experience PlatformUI删除数据集

当使用Experience Platform用户界面删除已启用用户档案的数据集时,会打开一个对话框,询问“您确定要从体验数据湖中删除此数据集吗? 使用“用户档案系统作业”API从用户档案服务中删除此数据集。”
在UI 中单击 “删除”将禁用数据集以进行摄取,但“不”会自动删除后端中的数据集。 要永久删除数据集,必须使用本指南中创建删除请求的步骤手动 创建删除请求
下图显示了尝试使用UI删除启用用户档案的数据集时的警告。
有关使用数据集的更多信息,请首先阅读数据集 概述