Endpoint quota

L'endpoint /quota nell'API di igiene dei dati consente di monitorare l'utilizzo di Advanced Data Lifecycle Management rispetto ai limiti di quota dell'organizzazione per ogni tipo di processo.

Le quote vengono applicate per ogni tipo di processo del ciclo di vita dei dati nei seguenti modi:

  • Le eliminazioni e gli aggiornamenti dei record sono limitati a un determinato numero di richieste al mese.
  • Le scadenze dei set di dati hanno un limite fisso per il numero di processi attivi simultaneamente, indipendentemente da quando verranno eseguite.

Introduzione

L’endpoint utilizzato in questa guida fa parte dell’API di igiene dei dati. Prima di continuare, esaminare la panoramica per le seguenti informazioni:

  • Collegamenti alla documentazione correlata
  • Guida alla lettura delle chiamate API di esempio in questo documento
  • Informazioni importanti sulle intestazioni necessarie per effettuare chiamate a qualsiasi API Experience Platform

Elenca quote list

È possibile visualizzare le informazioni sulle quote della propria organizzazione effettuando una richiesta di GET all'endpoint /quota.

Formato API

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

Parametro di query facoltativo che specifica il tipo di quota da recuperare. Se non viene fornito alcun parametro quotaType, nella risposta API vengono restituiti tutti i valori di quota. I valori di tipo accettati includono:

  • datasetExpirationQuota: questo oggetto mostra il numero di scadenze di set di dati attivi simultaneamente per l'organizzazione e la tolleranza totale di scadenze.
  • dailyConsumerDeleteIdentitiesQuota: questo oggetto mostra il numero totale di richieste di eliminazione record effettuate dall'organizzazione oggi e la quota giornaliera totale.
    Nota: vengono conteggiate solo le richieste accettate. Se un ordine di lavoro viene rifiutato perché non supera la convalida, le eliminazioni di identità non vengono conteggiate in base alla quota.
  • monthlyConsumerDeleteIdentitiesQuota: questo oggetto mostra il numero totale di richieste di eliminazione dei record effettuate dall'organizzazione questo mese e l'indennità mensile totale.
  • monthlyUpdatedFieldIdentitiesQuota: questo oggetto mostra il numero totale di richieste di aggiornamenti dei record effettuate dall'organizzazione questo mese e l'indennità mensile totale.

Richiesta

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'

Risposta

In caso di esito positivo, la risposta restituisce i dettagli delle quote del ciclo di vita dei dati.

{
  "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
    }
  ]
}
Proprietà
Descrizione
quotas

Elenca le informazioni sulla quota per ogni tipo di processo del ciclo di vita dei dati. Ogni oggetto quota contiene le proprietà seguenti:

  • name: tipo di processo del ciclo di vita dei dati:

    • expirationDatasetQuota: scadenze set di dati
    • deleteIdentityWorkOrderDatasetQuota: eliminazioni record
  • description: descrizione del tipo di processo del ciclo di vita dei dati.

  • consumed: numero di processi di questo tipo eseguiti nel periodo corrente. Il nome dell'oggetto indica il periodo di quota.

  • quota: l'assegnazione per questo tipo di processo per la tua organizzazione. Per le eliminazioni e gli aggiornamenti dei record, la quota rappresenta il numero di processi che è possibile eseguire per ogni periodo mensile. Per le scadenze dei set di dati, la quota rappresenta il numero di processi che possono essere attivi contemporaneamente in un dato momento.

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