Restaura una instantánea de un clúster del proyecto especificado. Atlas toma instantáneas bajo demanda inmediatamente y programa instantáneas a intervalos regulares. Si existe una instantánea bajo demanda con estado queued o inProgress, antes de tomar otra instantánea, espere a que Atlas termine de procesar la instantánea bajo demanda anterior.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de administrador de copias de seguridad de proyectos, el rol de operador de exportación de copias de seguridad de proyectos o el rol de operador de recuperación de copias de seguridad de proyectos.
Parámetros de ruta
-
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.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de consulta
-
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.Impresión bonita
Cuerpo
Requerido
Restaura una instantánea de un clúster del proyecto especificado.
-
Etiqueta legible por humanos que categoriza el trabajo de restauración a crear.
Los valores son
automated,downloadopointInTime. -
Número de operación del registro de operaciones desde el que se desea restaurar esta instantánea. Este número representa la segunda parte de una marca de tiempo del registro de operaciones. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"yoplogTssuperan0.El valor mínimo es
1. -
Fecha y hora desde las que desea restaurar esta instantánea. Este parámetro expresa la marca de tiempo en segundos transcurridos desde la época UNIX. Este número representa la primera parte de una marca de tiempo de registro de operaciones. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"yoplogTssuperan0.El valor mínimo es
1199145600. -
Fecha y hora desde las que MongoDB Cloud restauró esta instantánea. Este parámetro expresa la marca de tiempo en segundos transcurridos desde la época UNIX. El recurso devuelve este parámetro cuando
"deliveryType" : "pointInTime"ypointInTimeUTCSecondssuperan0.El valor mínimo es
1199145600. -
Cadena de caracteres hexadecimales 24única que identifica la instantánea.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible que identifica el clúster de destino donde el trabajo de restauración restaura la instantánea. El recurso devuelve este parámetro cuando
"deliveryType":"automated". Obligatorio para los tipos de restauraciónautomatedypointInTime.El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$. -
Cadena hexadecimal única 24que identifica el proyecto de destino para el
targetClusterNameespecificado. Obligatorio para los tipos de restauraciónautomatedypointInTime.El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
atlas api cloudBackups createBackupRestoreJob --helpimport (
"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.CreateGroupClusterBackupRestoreJobApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
CreateGroupClusterBackupRestoreJobWithParams(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}/backup/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}/backup/restoreJobs" \
-d '{ <Payload> }'{
"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": "2026-05-04T09:42:00Z",
"increment": 1199145600
},
"expired": true,
"expiresAt": "2026-05-04T09:42:00Z",
"failed": true,
"finishedAt": "2026-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": "2026-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"
}