配額端點

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
資料衛生

建立對象：

開發人員

資料衛生API中的/quota端點可讓您根據貴組織每種工作型別的配額限制，監控進階資料生命週期管理的使用情況。

配額會以下列方式針對每個資料生命週期工作型別強制執行：

記錄刪除和更新限製為每月特定數量的請求。
資料集過期時間對同時作用中的工作數量有固定限制，無論何時執行過期。

快速入門

本指南中使用的端點屬於資料衛生API。在繼續之前，請檢閱總覽以取得下列資訊：

相關檔案的連結
閱讀本檔案中範例API呼叫的指南
關於呼叫任何Experience PlatformAPI所需標題的重要資訊

清單配額 list

您可以透過向/quota端點發出GET要求來檢視您組織的配額資訊。

API格式

GET /quota
GET /quota?quotaType={QUOTA_TYPE}

參數

說明

{QUOTA_TYPE}

選擇性查詢引數，指定要擷取的配額型別。如果未提供quotaType引數，則API回應中會傳回所有配額值。接受的型別值包括：

datasetExpirationQuota：此物件顯示貴組織同時作用中的資料集到期數目，以及您的到期總允許。
dailyConsumerDeleteIdentitiesQuota：此物件顯示貴組織今天提出的記錄刪除請求總數，以及您的每日津貼總額。
注意：僅計算已接受的請求。如果工單因驗證失敗而被拒絕，這些身分刪除不會計入您的配額。
monthlyConsumerDeleteIdentitiesQuota：此物件顯示貴組織本月提出的記錄刪除請求總數，以及您的每月津貼總額。
monthlyUpdatedFieldIdentitiesQuota：此物件顯示貴組織本月提出的記錄更新要求總數，以及您的每月津貼總額。

要求

curl -X GET \
  https://platform.adobe.io/data/core/hygiene/quota \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Content-Type: application/json'

回應

成功的回應會傳回資料生命週期配額的詳細資料。

{
  "quotas": [
    {
      "name": "datasetExpirationQuota",
      "description": "The number of concurrently active Expiration Dataset Delete in all workorder requests for the organization.",
      "consumed": 12,
      "quota": 50
    },
    {
      "name": "dailyConsumerDeleteIdentitiesQuota",
      "description": "The consumed number of deleted identities in all workorder requests for the organization for today.",
      "consumed": 0,
      "quota": 600000
    },
    {
      "name": "monthlyConsumerDeleteIdentitiesQuota",
      "description": "The consumed number of deleted identities in all workorder requests for the organization for this month.",
      "consumed": 841,
      "quota": 600000
    },
    {
      "name": "monthlyUpdatedFieldIdentitiesQuota",
      "description": "The consumed number of updated identities in all workorder requests for the organization for this month.",
      "consumed": 0,
      "quota": 0
    }
  ]
}

屬性

說明

quotas

列出每個資料生命週期工作型別的配額資訊。每個配額物件都包含下列屬性：

name：資料生命週期工作型別：
- expirationDatasetQuota：資料集有效期
- deleteIdentityWorkOrderDatasetQuota：記錄刪除
description：資料生命週期工作型別的說明。
consumed：此型別在目前期間執行的作業數目。物件名稱表示配額期間。
quota：貴組織此工作型別的配額。對於記錄刪除和更新，配額表示每個月期間可以執行的工作數量。對於資料集有效期，配額代表可以在任何指定時間同時作用的工作數量。

recommendation-more-help

332f81c1-51e7-4bde-8327-2eb07f09604f