配置文件系统作业端点(删除请求)
Adobe Experience Platform允许您从多个源摄取数据,并为个别客户构建可靠的配置文件。 数据被引入 Platform 存储在 Data Lake,并且如果为配置文件启用了数据集,则该数据将存储在 Real-Time Customer Profile 数据存储区。 有时候,可能有必要从配置文件存储中删除数据集或批次,以删除不再需要或添加错误的数据。 这需要使用 Real-Time Customer Profile 用于创建应用程序的API Profile 系统作业,或 delete request
,如有必要,还可以修改、监视或移除这些组件。
快速入门
本指南中使用的API端点是 Real-Time Customer Profile 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 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"
)。创建删除请求 create-a-delete-request
新删除请求是通过向发出的POST请求来启动的 /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请求。 这可用于查找请求并检查其状态。 此 status
对于创建时的请求,为 "NEW"
直到它开始处理。 此 dataSetId
在响应中应匹配 dataSetId
在请求中发送。
{
"id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
"imsOrgId": "{ORG_ID}",
"dataSetId": "5c802d3cd83fc114b741c4b5",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559025404,
"updateEpoch": 1559025406
}
id
dataSetId
删除批次
要删除批次,批次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请求。 这可用于查找请求并检查其状态。 此 "status"
对于创建时的请求,为 "NEW"
直到它开始处理。 此 "batchId"
响应中的值应与 "batchId"
请求中发送的值。
{
"id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
"imsOrgId": "{ORG_ID}",
"batchId": "8d075b5a178e48389126b9289dcfd0ac",
"jobType": "DELETE",
"status": "NEW",
"createEpoch": 1559026131,
"updateEpoch": 1559026132
}
id
batchId
如果尝试启动记录数据集批次的删除请求,您将遇到400级错误,如下所示:
{
"requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
"errors": {
"400": [
{
"code": "500",
"message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
}
]
}
}
查看特定的删除请求 view-a-specific-delete-request
要查看特定删除请求(包括其状态等详细信息),您可以向以下地址执行查找(GET)请求: /system/jobs
端点并在路径中包含删除请求的ID。
API格式
GET /system/jobs/{DELETE_REQUEST_ID}
{DELETE_REQUEST_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}
请求
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 范围 Experience Platform,您可以安全地删除错误添加或您的组织不再需要的数据。 请注意,删除请求无法撤消,因此您应该只删除确信现在不需要且将来不需要的数据。