Crear un trabajo de restauración para un clúster M2 o M5 | Documentación de la API de administración de Atlas v1 (obsoleta)

Crear un trabajo de restauración para un clúster M2 o M5 Obsoleto

PUBLICAR /api/atlas/v1.0/grupos/{ID de grupo}/clústeres/{nombre del clúster}/copia de seguridad/inquilino/restauración

Cuentas de servicio Autorización de resumen

Restaura el clúster M2 o M5 especificado. MongoDB Cloud limita qué clústeres pueden ser los clústeres de destino de una restauración. El clúster de destino no puede usar cifrado en reposo, ejecutar una versión principal de MongoDB distinta a la de la instantánea ni recibir solicitudes de cliente durante las restauraciones. MongoDB Cloud elimina todos los datos existentes en el clúster de destino antes de la restauración. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto.

Este punto de conexión también se puede usar en clústeres Flex creados con el punto de conexión "Crear clúster" o en clústeres M 2/M anteriores5 que se hayan migrado a clústeres Flex hasta el de enero 22 del, 2026 fecha a partir de la cual este punto de conexión dejará de estar disponible. En su lugar, utilice el punto de conexión "Crear trabajo de copia de seguridad y restauración de Flex".

Crear trabajo de restauración de copia de seguridad de Flex

Parámetros de ruta

nombre del clúster string Requerido

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-]*$.
ID de grupo string Requerido

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})$.

Parámetros de consulta

envolvente booleano

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.
bonita booleano

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

El valor predeterminado es false.

Impresión bonita

aplicación/json

Cuerpo Requerido

Los detalles del trabajo de restauración.

snapshotId string Requerido

Cadena de dígitos hexadecimales 24única que identifica la instantánea a restaurar.

El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
nombreDeImplementaciónDeDestino string Requerido

Etiqueta legible que identifica el clúster del proyecto de destino donde desea restaurar la instantánea. Puede restaurar la instantánea a un nivel de clúster M2 o superior.

El formato debe coincidir con el siguiente patrón: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
ID de proyecto objetivo string

Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene el clúster en el que desea restaurar la instantánea.

El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Respuestas

200 aplicación/json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- nombre del clúster string
  
  Etiqueta legible por humanos que identifica el clúster de origen.
  
  El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.
- tipo de entrega string
  
  Medio por el cual este recurso devuelve la instantánea al usuario de MongoDB Cloud que la solicita.
  
  Los valores son RESTORE o DOWNLOAD.
- expirationDate cadena(fecha-hora)
  
  Fecha y hora en que el enlace de descarga dejó de funcionar. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
- ID. string
  
  Cadena de dígitos hexadecimales 24única que identifica el trabajo de restauración.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
- enlaces matriz[objeto]
  
  Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.
  
  Especificación de enlaces web (RFC...
  
  Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
  
  href string
  
  Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.
  
  relación string
  
  Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.
- ID del proyecto string
  
  Cadena de dígitos hexadecimales 24única que identifica el proyecto desde el cual se originó el trabajo de restauración.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
- fecha de finalización de restauración cadena(fecha-hora)
  
  Fecha y hora en que MongoDB nube completó la escritura de este snapshot. MongoDB Cloud cambia el estado de la tarea de restauración a CLOSED. Este parámetro expresa su valor en el formato de marcado de tiempo 8601 ISO en UTC.
- restaurarFechaProgramada cadena(fecha-hora)
  
  Fecha y hora en que MongoDB Cloud restaurará esta instantánea. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.
- Fecha de finalización de la instantánea cadena(fecha-hora)
  
  Fecha y hora en que MongoDB nube completó la escritura de este snapshot. Este parámetro expresa su valor en el formato de timestamp ISO 8601 en UTC.
- snapshotId string Requerido
  
  Cadena de dígitos hexadecimales 24única que identifica la instantánea a restaurar.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
- URL de instantánea string
  
  Dirección de Internet desde la cual puedes descargar los archivos comprimidos de snapshot. El recurso devuelve este parámetro cuando "deliveryType" : "DOWNLOAD".
- Estado string
  
  Fase del flujo de trabajo de restauración para este trabajo en el momento en que este recurso realizó esta solicitud.
  
  Los valores son PENDING, QUEUED, RUNNING, FAILED o COMPLETED.
- nombreDeImplementaciónDeDestino string Requerido
  
  Etiqueta legible que identifica el clúster del proyecto de destino donde desea restaurar la instantánea. Puede restaurar la instantánea a un nivel de clúster M2 o superior.
  
  El formato debe coincidir con el siguiente patrón: ^[\p{L}\p{N}\-_.(),:&@+']{1,64}$.
- ID de proyecto objetivo string
  
  Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene el clúster en el que desea restaurar la instantánea.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
400 aplicación/json

Solicitud incorrecta.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
401 aplicación/json

No autorizado.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
403 aplicación/json

Forbidden.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
404 aplicación/json

No se encontró.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
409 aplicación/json

Conflicto.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.
500 aplicación/json

Error Interno del Servidor.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.

publicación /api/atlas/v1.0/groups/{groupId}/clústeres/{clusterName}/copia de seguridad/inquilino/restauración

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/tenant/restore' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"snapshotId":"32b6e34b3d91647abb20e7b8","targetDeploymentItemName":"string","targetProjectId":"32b6e34b3d91647abb20e7b8"}'

Solicitar ejemplos

{
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Ejemplos de respuestas (200)

{
  "clusterName": "string",
  "deliveryType": "RESTORE",
  "expirationDate": "2026-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "projectId": "32b6e34b3d91647abb20e7b8",
  "restoreFinishedDate": "2026-05-04T09:42:00Z",
  "restoreScheduledDate": "2026-05-04T09:42:00Z",
  "snapshotFinishedDate": "2026-05-04T09:42:00Z",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "snapshotUrl": "string",
  "status": "PENDING",
  "targetDeploymentItemName": "string",
  "targetProjectId": "32b6e34b3d91647abb20e7b8"
}

Ejemplos de respuestas (400)

{
  "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"
}

Ejemplos de respuestas (401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

Ejemplos de respuestas (403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

Ejemplos de respuestas (404)

{
  "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"
}

Ejemplos de respuestas (409)

{
  "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"
}

Ejemplos de respuestas (500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}