Endpoint da cota
O ponto de extremidade /quota na API da higiene de dados permite monitorar o uso do Gerenciamento avançado do ciclo de vida de dados em relação aos limites de cota da organização para cada tipo de trabalho.
As cotas são aplicadas para cada tipo de trabalho do ciclo de vida dos dados das seguintes maneiras:
- As exclusões e atualizações de registros estão limitadas a um determinado número de solicitações a cada mês.
- As expirações de conjunto de dados têm um limite simples para o número de trabalhos ativos simultaneamente, independentemente de quando as expirações serão executadas.
Introdução
O endpoint usado neste guia faz parte da API de higiene de dados. Antes de continuar, consulte a visão geral para obter as seguintes informações:
- Links para a documentação relacionada
- Um guia para ler as chamadas de API de amostra neste documento
- Informações importantes sobre os cabeçalhos necessários para fazer chamadas para qualquer API Experience Platform
Listar cotas list
Você pode exibir as informações de cota de sua organização fazendo uma solicitação GET para o ponto de extremidade /quota.
Formato da API
GET /quota
GET /quota?quotaType={QUOTA_TYPE}
{QUOTA_TYPE}Um parâmetro de consulta opcional que especifica o tipo de cota a ser recuperada. Se nenhum parâmetro quotaType for fornecido, todos os valores de cota serão retornados na resposta da API. Os valores de tipo aceitos incluem:
datasetExpirationQuota: esse objeto mostra o número de expirações de conjunto de dados ativas simultaneamente para sua organização, e sua permissão total de expirações.dailyConsumerDeleteIdentitiesQuota: este objeto mostra o número total de solicitações de exclusão de registro feitas hoje pela sua organização e o total de ajudas de custo diárias.
Observação: somente as solicitações aceitas são contadas. Se uma ordem de serviço for rejeitada por falhar na validação, essas exclusões de identidade não serão consideradas na sua cota.monthlyConsumerDeleteIdentitiesQuota: este objeto mostra o número total de solicitações de exclusão de registro feitas por sua organização este mês e sua permissão mensal total.monthlyUpdatedFieldIdentitiesQuota: este objeto mostra o número total de solicitações de atualizações de registro feitas por sua organização este mês e sua mesada mensal total.
Solicitação
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'
Resposta
Uma resposta bem-sucedida retorna os detalhes das cotas de ciclo de vida dos dados.
{
"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
}
]
}
quotasLista as informações de cota para cada tipo de trabalho do ciclo de vida dos dados. Cada objeto de cota contém as seguintes propriedades:
-
name: O tipo de trabalho do ciclo de vida dos dados:expirationDatasetQuota: Expirações do conjunto de dadosdeleteIdentityWorkOrderDatasetQuota: exclusões de registro
-
description: uma descrição do tipo de trabalho do ciclo de vida dos dados. -
consumed: O número de trabalhos desse tipo executados no período atual. O nome do objeto indica o período de cota. -
quota: A atribuição para este tipo de trabalho para sua organização. Para exclusões e atualizações de registros, a cota representa o número de trabalhos que podem ser executados para cada período mensal. Para expirações de conjunto de dados, a cota representa o número de trabalhos que podem estar ativos simultaneamente em um determinado momento.