文件Experience Platform即時客戶設定檔指南

設定檔系統作業端點（刪除請求）

最後更新： 2026年10月7日

建立對象：

  • 開發人員

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
sort
您要排序傳回結果的順序。 唯一支援的值是createdAt。 您可以依照​遞增 (asc)或​遞減 (desc)順序排序此值。 依預設，系統作業會以遞增順序傳回。
sort=createdAt:desc

例如，如果您有查詢引數?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",
            "metrics": {
                "successRecords": 2305,
                "failedRecords": 0,
                "totalScannedRecords": 2305,
                "timeTakenInSec": 1353
            }
        },
        {
            "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",
            "metrics": {
                "successRecords": 7756,
                "failedRecords": 0,
                "totalScannedRecords": 7756,
                "timeTakenInSec": 2699
            }
        }
    ]
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
屬性 說明
requestId 系統作業的ID。
requestType 系統作業的型別。 可能的值包括BACKFILL_TTL、DELETE_EE_BATCH和TRUNCATE_DATASET。
status 系統作業的狀態。 可能的值包括NEW、SUCCESS、ERROR、FAILED和IN-PROGRESS。
properties 包含批次和/或系統作業之資料集ID的物件。
metrics 包含系統作業之測量結果資料的物件。 這包括成功記錄數、失敗記錄數、掃描的記錄總數以及處理系統作業所花費的時間等資訊。 此物件​ 不是 ​用於程式化服務對服務整合，且是供資訊使用。

建立刪除請求 create-a-delete-request

初始化新的刪除請求是透過POST請求完成至/systems/jobs端點，其中要刪除的資料集或批次識別碼會提供在請求內文中。

刪除資料集和相關聯的設定檔資料

若要從設定檔存放區中刪除資料集及與資料集相關聯的所有設定檔資料，必須在POST請求內文中包含資料集ID。 此動作將會刪除指定資料集的所有資料。 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。 這可用來查閱請求並檢查其狀態。 建立時要求的status是NEW，直到它開始處理為止(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 系統產生的系統作業唯讀識別碼。
requestType 系統作業的型別。 由於您正在刪除資料集，因此值為TRUNCATE_DATASET。
status 系統作業的狀態。 可能的值包括NEW、SUCCESS、ERROR、FAILED和IN-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 系統產生的系統作業唯讀識別碼。
requestType 系統作業的型別。 由於您正在刪除批次，因此值為DELETE_EE_BATCH。
status 系統作業的狀態。 可能的值包括NEW、SUCCESS、ERROR、FAILED和IN-PROGRESS。
properties 包含系統作業之批次和資料集ID的物件。
IMPORTANT
建立刪除要求是​ 非同步 ​程式。 因此，您可能需要使用檢視特定的刪除要求端點來檢查刪除要求的狀態，以確保刪除要求已成功建立。

如果您嘗試起始記錄型資料集的刪除請求，該請求將會失敗。 若要檢查刪除要求的狀態，請使用系統工作的requestId執行檢視特定的刪除要求。 在此情況下，將會填入errors欄位，其完整回應類似於以下內文：

{
    "requestId": "ef78b766-a19c-4d89-8bb6-721021b18884",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
           "sandbox": {
        "sandboxName": "{SANDBOX_NAME}",
        "sandboxId": "{SANDBOX_ID}",
        "default": false,
        "type": "development"
    },
    "status": "FAILED",
    "properties": {
        "batchId": "91JFSYFDFW9JAAEKHX672JMPSB",
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T07:34:46.122504Z",
    "updatedAt": "2024-12-22T07:35:08.400143Z",
    "errors": {
        "code": "UPAPI-113323-400",
        "message": "Dataset must be an Experience Event dataset"
    }
}

檢視特定的刪除請求 view-a-specific-delete-request

若要檢視特定的刪除要求，包括其狀態等詳細資訊，您可以對/system/jobs端點執行查詢(GET)要求，並在路徑中包含刪除要求的識別碼。

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",
    "metrics": {
        "successRecords": 7756,
        "failedRecords": 0,
        "totalScannedRecords": 7756,
        "timeTakenInSec": 2699
    }
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
屬性 說明
requestId 系統產生的系統作業唯讀識別碼。
requestType 系統作業的型別。 可能的值包括BACKFILL_TTL、DELETE_EE_BATCH和TRUNCATE_DATASET。
status 系統作業的狀態。 可能的值包括NEW、SUCCESS、ERROR、FAILED和IN-PROGRESS。
properties 包含批次和/或系統作業之資料集ID的物件。
metrics 包含系統作業之測量結果資料的物件。 這包括成功記錄數、失敗記錄數、掃描的記錄總數以及處理系統作業所花費的時間等資訊。 此物件​ 不是 ​用於程式化服務對服務整合，且是供資訊使用。

刪除請求狀態為"SUCCESS"後，您可以嘗試使用資料存取API存取已刪除的資料，以確認資料已刪除。 如需如何使用資料存取API存取資料集和批次的指示，請檢閱資料存取檔案。

後續步驟

現在您已經知道從Experience Platform內的Profile store刪除資料集和批次所涉及的步驟，您可以安全地刪除已錯誤新增或您的組織不再需要的。 請注意，刪除請求無法復原，因此您應該僅刪除確信現在不需要且未來不需要的資料。

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