Crea una tarea de restauración para una instancia sin servidor. Obsoleto

PUBLICAR /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs

Restaura una instantánea de una instancia sin servidor del proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto.

Esta API también se puede usar en clústeres Flex creados con el punto de conexión "Crear instancia sin servidor" o en clústeres Flex migrados desde instancias sin servidor. Este punto de conexión dejará de estar disponible el de enero 22 del. En su2026 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

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

  • nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica la instancia sin servidor cuya instantánea desea restaurar.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Restaura una instantánea de una instancia sin servidor del proyecto especificado.

  • tipo de entrega string Requerido

    Etiqueta legible por humanos que categoriza el trabajo de restauración a crear.

    Los valores son automated, download o pointInTime.

  • oplogInc integer(int32)

    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" y oplogTs superan 0.

    El valor mínimo es 1.

  • oplogTs integer(int32)

    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" y oplogTs superan 0.

    El valor mínimo es 1199145600.

  • puntoEnTiempoUTCSegmentos integer(int32)

    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" y pointInTimeUTCSeconds superan 0.

    El valor mínimo es 1199145600.

  • snapshotId string

    Cadena de caracteres hexadecimales 24única que identifica la instantánea.

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

  • nombreDeClusterObjetivo string Requerido

    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".

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

  • ID de grupo objetivo string Requerido

    Cadena de dígitos hexadecimales 24única que identifica el proyecto de destino para el targetClusterName ​​especificado.

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

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • cancelado booleano

      Bandera que indica si alguien canceló este trabajo de restauración.

    • tipo de entrega string Requerido

      Etiqueta legible por humanos que categoriza el trabajo de restauración a crear.

      Los valores son automated, download o pointInTime.

    • deliveryUrl array[string]

      Una o varias URL (localizadores uniformes de recursos) que apunten a los archivos comprimidos del snapshot para su descarga manual. MongoDB nube devuelve este parámetro cuando "deliveryType" : "download".

    • Marca de tiempo deseada Objeto

      Marca de tiempo BSON que indica cuándo se produjo la entrada del token del punto de control en el registro de operaciones.

      Ocultar los atributos de marca de tiempo deseados Mostrar atributos desiredTimestamp Objeto
      • fecha cadena(fecha-hora)

        Fecha y hora en que el registro de operaciones registró esta operación de base de datos. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • incremento integer(int32)

        Orden de la operación de la base de datos que el oplog registró en una fecha y hora específicas.

        El valor mínimo es 1199145600.

    • expirado booleano

      Bandera que indica si el trabajo de restauración expiró.

    • expira en cadena(fecha-hora)

      Fecha y hora de vencimiento del trabajo de restauración. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • fracasado booleano

      Bandera que indica si el trabajo de restauración falló.

    • Terminado en cadena(fecha-hora)

      Fecha y hora de finalización del trabajo de restauración. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • ID. string

      Cadena de caracteres hexadecimales 24única que identifica el trabajo de restauración.

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

    • oplogInc integer(int32)

      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" y oplogTs superan 0.

      El valor mínimo es 1.

    • oplogTs integer(int32)

      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" y oplogTs superan 0.

      El valor mínimo es 1199145600.

    • puntoEnTiempoUTCSegmentos integer(int32)

      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" y pointInTimeUTCSeconds superan 0.

      El valor mínimo es 1199145600.

    • snapshotId string

      Cadena de caracteres hexadecimales 24única que identifica la instantánea.

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

    • nombreDeClusterObjetivo string Requerido

      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".

      El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

    • ID de grupo objetivo string Requerido

      Cadena de dígitos hexadecimales 24única que identifica el proyecto de destino para el targetClusterName ​​especificado.

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

    • fecha y hora cadena(fecha-hora)

      Fecha y hora en que MongoDB Cloud tomó la instantánea asociada a snapshotId. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

  • 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.

POST /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs
atlas api cloudBackups createServerlessRestoreJob --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.CreateGroupServerlessBackupRestoreJobApiParams{}
	sdkResp, httpResp, err := client.CloudBackupsApi.
		CreateGroupServerlessBackupRestoreJobWithParams(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}/serverless/{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}/serverless/{clusterName}/backup/restoreJobs" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "deliveryType": "automated",
  "oplogInc": 1,
  "oplogTs": 42,
  "pointInTimeUTCSeconds": 42,
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetClusterName": "string",
  "targetGroupId": "32b6e34b3d91647abb20e7b8"
}
Ejemplos de respuestas (200)
{
  "cancelled": true,
  "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,
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetClusterName": "string",
  "targetGroupId": "32b6e34b3d91647abb20e7b8",
  "timestamp": "2026-05-04T09:42:00Z"
}
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"
}