Restaura una copia de seguridad heredada para un clúster en el proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto. A partir del 23 de marzo del 2020, todos los clústeres nuevos solo pueden usar copias de seguridad en la nube. Al actualizar a 4.2, su sistema de copia de seguridad se actualiza a la copia de seguridad en la nube si actualmente está configurado como copia de seguridad heredada. Después de esta actualización, todas sus instantáneas de copia de seguridad heredadas existentes siguen disponibles. Caducan con el tiempo de acuerdo con su política de retención. Su política de copia de seguridad se restablece a la programación predeterminada. Si tenía una política de copia de seguridad personalizada implementada con copias de seguridad heredadas, debe volver a crearla con el procedimiento descrito en la documentación de Cloud Backup. Este punto de conexión no admite la creación de trabajos de restauración de punto de control para clústeres fragmentados ni la creación de trabajos de restauración para instantáneas de copia de seguridad consultables. Si crea un trabajo de restauración automatizado especificando delivery.methodName de AUTOMATED_RESTORE en el cuerpo de su solicitud, MongoDB Cloud elimina todos los datos existentes en el clúster de destino antes de la restauración.
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
Etiqueta legible por humanos que identifica el clúster con la instantánea que desea devolver.
El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.
El valor predeterminado es false.
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es false.
Copia de seguridad heredada para restaurar en un clúster en el proyecto especificado.
Cadena única de dígitos hexadecimales 24que identifica el punto de control del clúster fragmentado. El punto de control representa el punto en el tiempo al que desea restaurar los datos. Este parámetro se aplica cuando "delivery.methodName" : "AUTOMATED_RESTORE". Úselo solo con clústeres fragmentados.
checkpointId, no podrá configurar oplogInc, oplogTs, snapshotId o pointInTimeUTCMillis.delivery.El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
Método y detalles que indican cómo entregar los datos de la snapshot restaurada.
Ordinario incremental de treinta y dos bits que representa las operaciones realizadas dentro de un segundo determinado. Al combinarse con oplogTs, representa el momento en el que MongoDB Cloud restaura sus datos. Este parámetro se aplica cuando "delivery.methodName" : "AUTOMATED_RESTORE".
oplogInc, debe configurar oplogTs y no puede configurar checkpointId, snapshotId o pointInTimeUTCMillis.delivery.El valor mínimo es 1.
Fecha y hora desde las que desea restaurar esta instantánea. Este parámetro expresa su valor en formato ISO 8601 en UTC. Representa la primera parte de una marca de tiempo de registro de operaciones. Al combinarse con oplogInc, representan la última operación de base de datos a la que desea restaurar los datos. Este parámetro se aplica cuando "delivery.methodName" : "AUTOMATED_RESTORE". Ejecute una consulta en local.oplog.rs en su conjunto de réplicas para encontrar la marca de tiempo deseada.
oplogTs, debe configurar oplogInc y no puede configurar checkpointId, snapshotId o pointInTimeUTCMillis.delivery.El formato debe coincidir con el siguiente patrón: ^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-][01]\\d:[0-5]\\d)$.
Marca de tiempo desde la que desea restaurar esta instantánea. Este parámetro expresa su valor en milisegundos transcurridos desde la época UNIX. Esta marca de tiempo debe estar dentro de las últimas 24 horas de la hora actual. Este parámetro se aplica cuando "delivery.methodName" : "AUTOMATED_RESTORE".
delivery.pointInTimeUTCMillis, no podrá configurar oplogInc, oplogTs, snapshotId o checkpointId.El valor mínimo es 1199145600000.
Cadena hexadecimal única 24que identifica la instantánea que se va a restaurar. Si se establece snapshotId, no se pueden establecer oplogInc, oplogTs, pointInTimeUTCMillis ni checkpointId.
El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
atlas api legacyBackup createClusterRestoreJob --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupClusterRestoreJobApiParams{}
sdkResp, httpResp, err := client.LegacyBackupApi.
CreateGroupClusterRestoreJobWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
-d '{ <Payload> }'
{
"checkpointId": "32b6e34b3d91647abb20e7b8",
"delivery": {
"expirationHours": 42,
"maxDownloads": 42,
"methodName": "CLIENT_PIT_HTTP",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8"
},
"oplogInc": 42,
"oplogTs": "string",
"pointInTimeUTCMillis": 42,
"snapshotId": "32b6e34b3d91647abb20e7b8"
}
{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"batchId": "32b6e34b3d91647abb20e7b8",
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"created": "2026-05-04T09:42:00Z",
"delivery": {
"authHeader": "string",
"authValue": "string",
"expirationHours": 42,
"expires": "2026-05-04T09:42:00Z",
"maxDownloads": 42,
"methodName": "CLIENT_PIT_HTTP",
"statusName": "NOT_STARTED",
"targetClusterId": "32b6e34b3d91647abb20e7b8",
"targetClusterName": "string",
"targetGroupId": "32b6e34b3d91647abb20e7b8",
"url": "string",
"urlV2": "string"
},
"deploymentJobId": "string",
"encryptionEnabled": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"hashes": [
{
"fileName": "string",
"hash": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"typeName": "SHA1"
}
],
"id": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"masterKeyUUID": "string",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"statusName": "IN_PROGRESS",
"timestamp": {
"date": "2026-05-04T09:42:00Z",
"increment": 1199145600
}
}
],
"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"
}