ドキュメント Experience Platform 詳細なデータライフサイクル管理ガイド

Quota エンドポイント

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

トピック：
データ衛生

作成対象：

開発者

Data Hygiene API の /quota エンドポイントを使用すると、各ジョブタイプの組織の割り当て量制限に対する高度なデータライフサイクル管理の使用状況を監視できます。

クォータは、次の方法でデータ・ライフサイクル・ジョブ・タイプごとに適用されます。

レコードの削除と更新は、1 か月あたり一定数のリクエストに制限されています。
データセットの有効期限には、有効期限が実行されるタイミングに関係なく、同時にアクティブなジョブの数に対して一定の制限があります。

はじめに

このガイドで使用するエンドポイントは、Data Hygiene API の一部です。続行する前に、概要で以下の情報を確認してください。

関連ドキュメントへのリンク
このドキュメントのサンプル API 呼び出しの読み方に関するガイド
Experience PlatformAPI を呼び出すために必要な必須ヘッダーに関する重要な情報

割り当て量のリスト list

/quota エンドポイントに対して GET リクエストを実行することで、組織の割り当て量の情報を表示できます。

API 形式

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

パラメーター

説明

{QUOTA_TYPE}

取得する割り当て量のタイプを指定するオプションのクエリパラメーター。quotaType パラメーターが指定されていない場合、すべての割り当て量の値が API 応答で返されます。使用できるタイプの値は次のとおりです。

datasetExpirationQuota：このオブジェクトは、組織で同時にアクティブなデータセットの有効期限の数と、有効期限の合計許容量を表示します。
dailyConsumerDeleteIdentitiesQuota：このオブジェクトには、組織が今日行ったレコード削除リクエストの合計数と、1 日あたりの合計使用量が表示されます。
注意：許可されたリクエストのみがカウントされます。作業指示が検証に失敗したために却下された場合、それらの ID 削除は割り当てにカウントされません。
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：組織に対するこのジョブタイプの割り当て。レコードの削除と更新の場合、割り当て量は、1 か月に実行できるジョブの数を表します。データセット有効期限の場合、割り当て量は、任意の時点で同時にアクティブにできるジョブの数を表します。

recommendation-more-help

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