Retornar todas as execuções do pipeline do Data Lake em um projeto
Obsoleto(a)
Retorna uma lista das execuções anteriores do Data Lake Pipeline. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível para humanos que identifica o Data Lake Pipeline.
O formato deve corresponder ao seguinte padrão:
^[^/\\ "$]{1,64}$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
O valor padrão é
true. -
Número de itens que a resposta retorna por página.
O valor mínimo é
1, o valor máximo é500. O valor padrão é100. -
Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
O valor mínimo é
1. O valor padrão é1. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
Se especificado, o Atlas retornará somente as execuções de pipeline data lake iniciadas antes dessa hora e data.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/pipelines/{pipelineName}/runs' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"_id": "32b6e34b3d91647abb20e7b8",
"backupFrequencyType": "HOURLY",
"createdDate": "2025-05-04T09:42:00Z",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetRetentionPolicy": {
"lastModifiedDate": "2025-05-04T09:42:00Z",
"units": "DAYS",
"value": 42
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2025-05-04T09:42:00Z",
"phase": "SNAPSHOT",
"pipelineId": "32b6e34b3d91647abb20e7b8",
"scheduledDeletionDate": "2025-05-04T09:42:00Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "PENDING",
"stats": {
"bytesExported": 42,
"numDocs": 42
}
}
],
"totalCount": 42
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}