Punto final de cuota
El /quota El punto final de la API de higiene de datos le permite supervisar el uso de la administración avanzada del ciclo vital de datos con respecto a los límites de cuotas de su organización para cada tipo de trabajo.
Las cuotas se aplican a cada tipo de trabajo del ciclo vital de datos de las siguientes maneras:
- Las eliminaciones y actualizaciones de registros se limitan a un determinado número de solicitudes cada mes.
- La caducidad de los conjuntos de datos tiene un límite plano para el número de trabajos activos simultáneamente, independientemente de cuándo se ejecutará la caducidad.
Introducción
El extremo utilizado en esta guía forma parte de la API de higiene de datos. Antes de continuar, consulte la descripción general para obtener la siguiente información:
- Vínculos a documentación relacionada
- Una guía para leer las llamadas de API de ejemplo en este documento
- Información importante sobre los encabezados necesarios para realizar llamadas a cualquier API de Experience Platform
Enumerar cuotas list
Puede ver la información de cuotas de su organización realizando una solicitud de GET a la /quota punto final.
Formato de API
GET /quota
GET /quota?quotaType={QUOTA_TYPE}
{QUOTA_TYPE}Parámetro de consulta opcional que especifica el tipo de cuota que se va a recuperar. Si no quotaType Si se proporciona el parámetro, todos los valores de cuota se devuelven en la respuesta de la API. Los valores de tipo aceptados incluyen:
datasetExpirationQuota: este objeto muestra el número de caducidades del conjunto de datos activas simultáneamente para su organización y la asignación total de caducidades.dailyConsumerDeleteIdentitiesQuota: este objeto muestra el número total de solicitudes de eliminación de registros realizadas por su organización hoy y su asignación diaria total.
Nota: Solo se cuentan las solicitudes aceptadas. Si se rechaza una orden de trabajo porque no supera la validación, esas eliminaciones de identidad no se contabilizan en la cuota.monthlyConsumerDeleteIdentitiesQuota: este objeto muestra el número total de solicitudes de eliminación de registros realizadas por su organización este mes y la asignación mensual total.monthlyUpdatedFieldIdentitiesQuota: este objeto muestra la cantidad total de solicitudes de actualización de registros realizadas por su organización este mes y la asignación mensual total.
Solicitud
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'
Respuesta
Una respuesta correcta devuelve los detalles de las cuotas del ciclo vital de datos.
{
"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
}
]
}
quotasMuestra la información de cuota de cada tipo de trabajo del ciclo vital de datos. Cada objeto de cuota contiene las siguientes propiedades:
-
name: el tipo de trabajo del ciclo vital de datos:expirationDatasetQuota: Caducidad del conjunto de datosdeleteIdentityWorkOrderDatasetQuota: Eliminaciones de registros
-
description: una descripción del tipo de trabajo del ciclo vital de datos. -
consumed: el número de trabajos de este tipo ejecutados en el periodo actual. El nombre del objeto indica el período de cuota. -
quota: Asignación para este tipo de trabajo para su organización. Para las eliminaciones y actualizaciones de registros, la cuota representa el número de trabajos que se pueden ejecutar para cada período mensual. Para las caducidades del conjunto de datos, la cuota representa el número de trabajos que pueden estar activos simultáneamente en un momento determinado.