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

Adobe Experience Platform允许您从多个源摄取数据,并为个别客户构建可靠的配置文件。 摄取到Experience Platform的数据存储在Data Lake中,如果为配置文件启用了数据集,则该数据也存储在Real-Time Customer Profile数据存储中。 有时候,可能有必要从配置文件存储中删除与数据集关联的配置文件数据,以便删除不再需要或添加错误的数据。 这需要使用Real-Time Customer Profile API创建Profile系统作业或“删除请求”。

NOTE
如果您尝试从Data Lake中删除数据集或批次,请访问目录服务概述以了解更多信息。

快速入门

本指南中使用的API终结点是Real-Time Customer Profile API的一部分。 在继续之前,请查看快速入门指南,以获取相关文档的链接、阅读本文档中示例API调用的指南,以及有关成功调用任何Experience Platform API所需的所需标头的重要信息。

查看删除请求 view

删除请求是一个长期运行的异步过程,这意味着您的组织可能同时运行多个删除请求。 要查看您的组织当前运行的所有删除请求,您可以对/system/jobs端点执行GET请求。

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

API格式

使用此端点时,前100个系统作业将根据其创建日期以升序返回。

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
参数
描述
示例
start
确定返回的结果集的起始页。 页码基于0,这意味着start=0将返回从0开始的结果。
start=4
limit
每页返回的结果数。
limit=10

例如,如果查询参数为?start=1&limit=10,则响应将返回记录10-19。

请求

查看系统作业的示例请求。
code language-shell
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}' \

响应

成功的响应将返回页面信息和一个子数组,该子数组包含每个系统请求的对象。

查看系统请求的成功响应
code language-json
{
    "_page": {
        "pageSize": 2,
        "start": "0",
        "totalCount": 2,
        "next": 1
    },
    "children:" [
        {
            "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
            "requestType": "DELETE_EE_BATCH",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        },
        {
            "requestId": "38a835eb-b491-4864-902b-be07fa4d6a6d",
            "requestType": "TRUNCATE_DATASET",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        }
    ]
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
属性 描述
requestId 系统作业的ID。
requestType 系统作业的类型。 可能的值包括BACKFILL_TTLDELETE_EE_BATCHTRUNCATE_DATASET
status 系统作业的状态。 可能的值包括NEWSUCCESSERRORFAILEDIN-PROGRESS
properties 包含系统作业的批次和/或数据集ID的对象。

创建删除请求 create-a-delete-request

启动新的删除请求是通过POST请求完成到/systems/jobs端点的操作,其中要删除的数据集或批次的ID会包含在请求正文中。

删除数据集和关联的配置文件数据

要从配置文件存储中删除数据集以及与数据集关联的所有配置文件数据,数据集ID必须包含在POST请求正文中。 此操作将删除给定数据集的所有数据。 Experience Platform允许您同时基于记录和时间序列架构删除数据集。

API格式

POST /system/jobs

请求

删除数据集的示例请求。
code language-shell
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": "66a92c5910df2d1767de13f3"
      }'
属性
描述
dataSetId
要删除的数据集的ID。

响应

成功的响应会返回新创建的系统请求的详细信息,包括请求的系统生成的唯一只读ID。 这可用于查找请求并检查其状态。 创建时请求的statusNEW,直到它开始处理(IN-PROGRESS)。 响应中的dataSetId应与请求中发送的dataSetId匹配。

创建删除请求的成功响应。
code language-json
{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "TRUNCATE_DATASET",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
属性 描述
requestId 系统生成的系统作业只读ID。
requestType 系统作业的类型。 由于您正在删除数据集,因此该值为TRUNCATE_DATASET
status 系统作业的状态。 可能的值包括NEWSUCCESSERRORFAILEDIN-PROGRESS
properties 包含系统作业的数据集ID的对象。

删除批次

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

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

有关记录和时序行为的更多信息,请查看XDM System概述中有关XDM数据行为🔗的部分。

API格式

POST /system/jobs

请求

删除批次的示例请求。
code language-shell
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": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
      }'
属性
描述
datasetId
要删除的批次的数据集的ID。
batchId
要删除的批次的ID。

响应

成功的响应会返回新创建的系统请求的详细信息。

创建删除请求的成功响应。
code language-json
{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
属性 描述
requestId 系统生成的系统作业只读ID。
requestType 系统作业的类型。 由于您正在删除批次,因此该值为DELETE_EE_BATCH
status 系统作业的状态。 可能的值包括NEWSUCCESSERRORFAILEDIN-PROGRESS
properties 包含系统作业批次和数据集ID的对象。

如果您尝试启动记录数据集批次的删除请求,则该请求将失败。

查看特定的删除请求 view-a-specific-delete-request

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

API格式

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

请求

查看配置文件作业的示例请求。
code language-shell
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匹配。

查看删除请求的成功响应。
code language-json
{
    "requestId": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "SUCCESS",
    "properties": {
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:52:13.380706Z"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
属性 描述
requestId 系统生成的系统作业只读ID。
requestType 系统作业的类型。 可能的值包括BACKFILL_TTLDELETE_EE_BATCHTRUNCATE_DATASET
status 系统作业的状态。 可能的值包括NEWSUCCESSERRORFAILEDIN-PROGRESS
properties 包含系统作业的批次和/或数据集ID的对象。

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

后续步骤

现在您已经知道从Experience Platform中的Profile store删除数据集和批次所涉及的步骤,您可以安全地删除已错误添加或您的组织不再需要的数据。 请注意,删除请求无法撤消,因此您应该只删除确信现在不需要且将来不需要的数据。

recommendation-more-help
experience-platform-help-profile