Ponto de extremidade de expiração do conjunto de dados
A variável /ttl
O endpoint na API da higiene de dados permite agendar datas de expiração para conjuntos de dados na Adobe Experience Platform.
A expiração de um conjunto de dados é apenas uma operação de exclusão com tempo atrasado. O conjunto de dados não está protegido enquanto isso, portanto, ele pode ser excluído por outros meios antes de atingir sua expiração.
A qualquer momento antes da exclusão do conjunto de dados ser iniciada, você pode cancelar a expiração ou modificar a hora do acionador. Depois de cancelar uma expiração de conjunto de dados, você pode reabri-la definindo uma nova expiração.
Depois que a exclusão do conjunto de dados for iniciada, seu trabalho de expiração será marcado como executing
e não poderá ser alterada. O conjunto de dados em si pode ser recuperável por até sete dias, mas somente por meio de um processo manual iniciado por meio de uma solicitação de serviço da Adobe. À medida que a solicitação é executada, o data lake, o Serviço de identidade e o Perfil do cliente em tempo real iniciam processos separados para remover o conteúdo do conjunto de dados de seus respectivos serviços. Depois que os dados forem excluídos dos três serviços, a expiração será marcada como executed
.
Introdução
O endpoint usado neste guia faz parte da API de higiene de dados. Antes de continuar, reveja o Guia da API para obter informações sobre cabeçalhos necessários para operações CRUD, mensagens de erro, coleções do Postman e como ler chamadas de API de amostra.
x-sandbox-name: {SANDBOX_NAME}
cabeçalho.Listar expirações do conjunto de dados list
Você pode listar todas as expirações de conjunto de dados para sua organização fazendo uma solicitação GET. Parâmetros de consulta podem ser usados para filtrar a resposta para resultados apropriados.
Formato da API
GET /ttl?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
&
caracteres. Parâmetros comuns incluem limit
e page
para paginação. Para obter uma lista completa de parâmetros de consulta suportados, consulte a seção apêndice.Solicitação
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl?updatedToDate=2021-08-01&author=LIKE%Jane Doe%25 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida lista as expirações do conjunto de dados resultantes. O exemplo a seguir foi truncado por questões de espaço.
{
"results": [
{
"ttlId": "SD-b16c8b48-a15a-45c8-9215-587ea89369bf",
"datasetId": "629bd9125b31471b2da7645c",
"datasetName": "Sample Acme dataset",
"sandboxName": "hygiene-beta",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2050-01-01T00:00:00Z",
"updatedAt": "2023-06-09T16:52:44.136028Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
}
],
"current_page": 0,
"total_pages": 1,
"total_count": 1
}
totalRecords
ttlDetails
Pesquisar uma expiração de conjunto de dados lookup
Para pesquisar uma expiração de conjunto de dados, faça uma solicitação GET com o datasetId
ou o ttlId
.
Formato da API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{TTL_ID}
{DATASET_ID}
{TTL_ID}
Solicitação
A solicitação a seguir pesquisa os detalhes de expiração do conjunto de dados 62759f2ede9e601b63a2ee14
:
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl/62759f2ede9e601b63a2ee14 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna os detalhes da expiração do conjunto de dados.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "62759f2ede9e601b63a2ee14",
"datasetName": "XtVRwq9-38734",
"sandboxName": "prod",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2024-12-31T23:59:59Z",
"updatedAt": "2024-05-11T15:12:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
ttlId
datasetId
datasetName
sandboxName
imsOrg
status
expiry
updatedAt
updatedBy
displayName
description
Tags de expiração de catálogo
Ao usar o API do catálogo para pesquisar detalhes do conjunto de dados, se o conjunto de dados tiver uma expiração ativa, ele será listado em tags.adobe/hygiene/ttl
.
O JSON a seguir representa uma resposta truncada para os detalhes de um conjunto de dados do catálogo, que apresenta um valor de expiração de 32503680000000
. O valor da tag codifica a expiração como um número inteiro de milissegundos desde o início da época do Unix.
{
"63212313c308d51b997858ba": {
"name": "Test Dataset",
"description": "A piecrust promise, made to be broken",
"imsOrg": "0FCC747E56F59C747F000101@AdobeOrg",
"sandboxId": "8dc51b90-d0f9-11e9-b164-ed6a398c8b35",
"tags": {
"adobe/hygiene/ttl": [ "32503680000000" ],
...
},
...
}
}
Criar ou atualizar uma expiração de conjunto de dados create-or-update
Crie ou atualize uma data de expiração para um conjunto de dados por meio de uma solicitação PUT. A solicitação PUT usa o datasetId
ou o ttlId
.
Formato da API
PUT /ttl/{DATASET_ID}
PUT /ttl/{TTL_ID}
{DATASET_ID}
{TTL_ID}
Solicitação
A solicitação a seguir agenda um conjunto de dados 5b020a27e7040801dedbf46e
para exclusão no final de 2022 (Hora Média de Greenwich). Se nenhuma expiração existente for encontrada para o conjunto de dados, uma nova expiração será criada. Se o conjunto de dados já tiver uma expiração pendente, essa expiração será atualizada com o novo expiry
valor.
curl -X PUT \
https://platform.adobe.io/data/core/hygiene/ttl/5b020a27e7040801dedbf46e \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"expiry": "2024-12-31T23:59:59Z",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}'
expiry
displayName
description
Resposta
Uma resposta bem-sucedida retorna os detalhes da expiração do conjunto de dados, com o status HTTP 200 (OK) se uma expiração pré-existente foi atualizada ou 201 (Criado) se não houver uma expiração pré-existente.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "5b020a27e7040801dedbf46e",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2024-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:38:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
ttlId
datasetId
imsOrg
status
expiry
updatedAt
updatedBy
Cancelar a expiração de um conjunto de dados delete
Você pode cancelar a expiração de um conjunto de dados fazendo uma solicitação DELETE.
pending
pode ser cancelado. A tentativa de cancelar uma expiração que foi executada ou já foi cancelada retorna um erro HTTP 404.Formato da API
DELETE /ttl/{EXPIRATION_ID}
{EXPIRATION_ID}
ttlId
da expiração do conjunto de dados que você deseja cancelar.Solicitação
A solicitação a seguir cancela a expiração de um conjunto de dados com a ID SD-b16c8b48-a15a-45c8-9215-587ea89369bf
:
curl -X DELETE \
https://platform.adobe.io/data/core/hygiene/ttl/SD-b16c8b48-a15a-45c8-9215-587ea89369bf \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna o status HTTP 204 (Sem conteúdo), e a expiração de status
atributo está definido como cancelled
.
Recuperar o histórico do status de expiração de um conjunto de dados retrieve-expiration-history
Você pode consultar o histórico do status de expiração de um conjunto de dados específico usando o parâmetro de consulta include=history
em uma solicitação de pesquisa. O resultado inclui informações sobre a criação da expiração do conjunto de dados, quaisquer atualizações que tenham sido aplicadas e seu cancelamento ou execução (se aplicável). Você também pode usar a variável ttlId
da expiração do conjunto de dados.
Formato da API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{TTL_ID}
{DATASET_ID}
{TTL_ID}
Solicitação
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl/62759f2ede9e601b63a2ee14?include=history \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Resposta
Uma resposta bem-sucedida retorna os detalhes da expiração do conjunto de dados, com uma history
que fornece os detalhes de sua status
, expiry
, updatedAt
, e updatedBy
para cada uma de suas atualizações registradas.
{
"ttlId": "SD-b16c8b48-a15a-45c8-9215-587ea89369bf",
"datasetId": "62759f2ede9e601b63a2ee14",
"datasetName": "Example Dataset",
"sandboxName": "prod",
"displayName": "Expiration Request 123",
"description": "Expiration Request 123 Description",
"imsOrg": "0FCC747E56F59C747F000101@AdobeOrg",
"status": "cancelled",
"expiry": "2022-05-09T23:47:30.071186Z",
"updatedAt": "2022-05-09T23:47:30.071186Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"history": [
{
"status": "created",
"expiry": "2032-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:38:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
},
{
"status": "updated",
"expiry": "2032-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:41:46.731002Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
},
{
"status": "cancelled",
"expiry": "2022-05-09T23:47:30.071186Z",
"updatedAt": "2022-05-09T23:47:30.071186Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
}
]
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
history
status
, expiry
, updatedAt
, e updatedBy
atributos para a expiração no momento da atualização.Apêndice
Parâmetros de consulta aceitos query-params
A tabela a seguir descreve os parâmetros de consulta disponíveis quando listar expirações do conjunto de dados:
description
, displayName
, e datasetName
todos os parâmetros contêm a capacidade de pesquisa por valores LIKE. Isso significa que você pode encontrar expirações agendadas do conjunto de dados chamadas: "Name123", "Name183", "DisplayName1234" pesquisando a cadeia de caracteres "Name1".author
created_by
é uma correspondência para a string de pesquisa. Se a string de pesquisa começar com LIKE
ou NOT LIKE
, o restante é tratado como um padrão de pesquisa SQL. Caso contrário, a cadeia de caracteres de pesquisa inteira será tratada como uma cadeia literal que deve corresponder exatamente ao conteúdo inteiro de um created_by
campo.author=LIKE %john%
, author=John Q. Public
cancelledDate
/ cancelledToDate
/ cancelledFromDate
updatedDate=2022-01-01
completedDate
/ completedToDate
/ completedFromDate
completedToDate=2021-11-11-06:00
createdDate
Observe que as datas sem um horário (como
2021-12-07
) representam a data e hora no início desse dia. Assim, createdDate=2021-12-07
refere-se a qualquer expiração criada em 7 de dezembro de 2021, 00:00:00
até 23:59:59.999999999
(UTC).createdDate=2021-12-07
createdFromDate
createdFromDate=2021-12-07T00:00:00Z
createdToDate
createdToDate=2021-12-07T23:59:59.999999999Z
datasetId
datasetId=62b3925ff20f8e1b990a7434
datasetName
datasetName=Acme
description
description=Handle expiration of Acme information through the end of 2024.
displayName
displayName=License Expiry
executedDate
/ executedFromDate
/ executedToDate
executedDate=2023-02-05T19:34:40.383615Z
expiryDate
/ expiryToDate
/ expiryFromDate
expiryFromDate=2099-01-01&expiryToDate=2100-01-01
limit
limit=50
orderBy
orderBy
parâmetro de consulta especifica a ordem de classificação dos resultados retornados pela API. Use-a para organizar os dados com base em um ou mais campos, em ordem crescente (ASC) ou decrescente (DESC). Use o prefixo + ou - para indicar ASC e DESC, respectivamente. Os seguintes valores são aceitos: displayName
, description
, datasetName
, id
, updatedBy
, updatedAt
, expiry
, status
.-datasetName
orgId
x-gw-ims-org-id
e é ignorada, a menos que a solicitação forneça um token de serviço.orgId=885737B25DC460C50A49411B@AdobeOrg
page
page=3
sandboxName
x-sandbox-name
cabeçalho. Uso sandboxName=*
para incluir expirações de conjunto de dados de todas as sandboxes.sandboxName=dev1
search
Corresponde a expirações em que a cadeia de caracteres especificada corresponde exatamente à ID de expiração ou é contido em qualquer um destes campos:
- autor
- nome de exibição
- descrição
- nome de exibição
- nome do conjunto de dados
search=TESTING
status
status=pending,cancelled
ttlId
ttlID=SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
updatedDate
/ updatedToDate
/ updatedFromDate
createdDate
/ createdFromDate
/ createdToDate
, mas corresponde a uma hora de atualização de expiração de conjunto de dados, em vez da hora de criação.Uma expiração é considerada atualizada em cada edição, incluindo quando é criada, cancelada ou executada.
updatedDate=2022-01-01