Point d’entrée du quota

Le point d’entrée /quota de l’API Data Hygiene vous permet de surveiller l’utilisation de la gestion avancée du cycle de vie des données par rapport aux limites de quota de votre entreprise pour chaque type de tâche.

Les quotas sont appliqués pour chaque type de tâche Data Lifecycle de la manière suivante :

  • Les suppressions d’enregistrements et les mises à jour sont limitées à un certain nombre de demandes par mois.
  • Les expirations de jeux de données ont une limite plate pour le nombre de traitements principaux simultanés, quelle que soit la date d’exécution des expirations.

Prise en main

Le point d’entrée utilisé dans ce guide fait partie de lʼAPI Data Hygiene. Avant de poursuivre, veuillez consulter la section Présentation pour obtenir les informations suivantes :

  • Liens vers la documentation connexe
  • Un guide de lecture des exemples d’appels API dans ce document
  • Informations importantes concernant les en-têtes requis pour effectuer des appels vers une API Experience Platform

Quotas de liste list

Vous pouvez afficher les informations sur le quota de votre entreprise en adressant une requête GET au point d’entrée /quota.

Format d’API

GET /quota
GET /quota?quotaType={QUOTA_TYPE}
Paramètre
Description
{QUOTA_TYPE}

Paramètre de requête facultatif qui spécifie le type de quota à récupérer. Si aucun paramètre quotaType n’est fourni, toutes les valeurs de quota sont renvoyées dans la réponse de l’API. Les valeurs de type acceptées sont les suivantes :

  • datasetExpirationQuota : cet objet indique le nombre d’expirations de jeux de données actives simultanées pour votre organisation, ainsi que votre limite totale d’expirations.
  • dailyConsumerDeleteIdentitiesQuota : cet objet indique le nombre total de demandes de suppression d’enregistrements effectuées par votre organisation aujourd’hui et votre allocation quotidienne totale.
    Remarque : Seules les demandes acceptées sont comptabilisées. Si une commande de travail est rejetée parce qu’elle ne parvient pas à être validée, ces suppressions d’identité ne sont pas prises en compte par rapport à votre quota.
  • monthlyConsumerDeleteIdentitiesQuota : cet objet indique le nombre total de demandes de suppression d’enregistrements effectuées par votre organisation ce mois-ci et votre allocation mensuelle totale.
  • monthlyUpdatedFieldIdentitiesQuota : cet objet indique le nombre total de demandes de mise à jour des enregistrements effectuées par votre organisation ce mois-ci et votre allocation mensuelle totale.

Requête

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'

Réponse

Une réponse réussie renvoie les détails des quotas de cycle de vie des données.

{
  "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
    }
  ]
}
Propriété
Description
quotas

Répertorie les informations de quota pour chaque type de tâche de cycle de vie des données. Chaque objet Quota contient les propriétés suivantes :

  • name : type de tâche du cycle de vie des données :

    • expirationDatasetQuota : expirations de jeux de données
    • deleteIdentityWorkOrderDatasetQuota : Suppressions d’enregistrements
  • description : description du type de tâche du cycle de vie des données.

  • consumed : nombre de tâches de ce type exécutées au cours de la période en cours. Le nom de l’objet indique la période du quota.

  • quota : allocation de ce type de tâche pour votre organisation. Pour les suppressions et mises à jour d’enregistrements, le quota représente le nombre de tâches pouvant être exécutées pour chaque période mensuelle. Pour les expirations de jeux de données, le quota représente le nombre de tâches pouvant être actives simultanément à un moment donné.

recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f