配额终结点

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