Restaurar um snapshot de um cluster
Restaura um snapshot de um cluster do projeto especificado. O Atlas faz snapshots sob demanda imediatamente e snapshots agendados periodicamente. Se houver um snapshot sob demanda com status queued ou inProgress, antes de fazer outro snapshot, aguarde até que o Atlas conclua o processamento do snapshot sob demanda tirado anteriormente.
Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de gerente de backup 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 por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
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 o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Restaura um snapshot de um cluster do projeto especificado.
-
Rótulo legível por humanos que categoriza a tarefa de restauração a ser criada.
Os valores são
automated,downloadoupointInTime. -
Número de operação Oplog da qual você deseja restaurar esse snapshot. Esse número representa a segunda parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando
"deliveryType" : "pointInTime"e oplogTs ultrapassam0.O valor mínimo é
1. -
Data e hora a partir das quais você deseja restaurar esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. Esse número representa a primeira parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando
"deliveryType" : "pointInTime"e oplogTs ultrapassam0.O valor mínimo é
1199145600. -
Data e hora em que a nuvem do MongoDB Cloud restaurou esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde o Unix epoch. O recurso retorna este parâmetro quando
"deliveryType" : "pointInTime"e pointInTimeUTCSeconds ultrapassam0.O valor mínimo é
1199145600. -
String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Rótulo legível por humanos que identifica o cluster de destino no qual a tarefa de restauração restaura o snapshot. O recurso retorna esse parâmetro quando
"deliveryType":"automated". Necessário para tipos de restauração doautomatedepointInTime.O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$. -
String exclusiva de 24 dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado. Necessário para tipos de restauração do
automatedepointInTime.O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/restoreJobs' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"deliveryType":"automated","oplogInc":1,"oplogTs":42,"pointInTimeUTCSeconds":42,"snapshotId":"32b6e34b3d91647abb20e7b8","targetClusterName":"string","targetGroupId":"32b6e34b3d91647abb20e7b8"}'{
"deliveryType": "automated",
"oplogInc": 1,
"oplogTs": 42,
"pointInTimeUTCSeconds": 42,
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
}{
"cancelled": true,
"components": [
{
"downloadUrl": "string",
"privateDownloadDeliveryUrls": [
{
"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"replicaSetName": "string"
}
],
"deliveryType": "automated",
"deliveryUrl": [
"string"
],
"desiredTimestamp": {
"date": "2025-05-04T09:42:00Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2025-05-04T09:42:00Z",
"failed": true,
"finishedAt": "2025-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oplogInc": 1,
"oplogTs": 42,
"pointInTimeUTCSeconds": 42,
"privateDownloadDeliveryUrls": [
{
"deliveryUrl": "string",
"endpointId": "vpce-3bf78b0ddee411ba1"
}
],
"snapshotId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"timestamp": "2025-05-04T09:42:00Z"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}