Devolver todos los trabajos de restauración para una instancia sin servidor Obsoleto

OBTENER /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs

Devuelve todos los trabajos de restauración para una instancia sin servidor del Proyecto especificado. Para utilizar este recurso, la Cuenta de Servicio solicitante o la Clave API deben tener el rol de Propietario del Proyecto.

Esta API también puede utilizarse en clústeres Flex que fueron creados con el punto final Crear instancia sin servidor o en clústeres Flex que se migraron desde instancias sin servidor. Este endpoint se descontinuará el 22 de enero de 2026. Por favor, utiliza el endpoint List Flex copia de seguridad restauración Jobs en su lugar.

Listar trabajos de restauración de copia de seguridad Flexible

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan 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.

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

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • includeCount booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor por defecto es true.

  • elementosPorPágina entero

    Número de elementos que la respuesta retorna por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • Num. de pág. entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Resultados arreglo[objeto] Requerido

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • cancelado booleano

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

      • deliveryType string Requerido

        Etiqueta legible por humanos que categoriza la tarea 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

        Timestamp BSON que indica cuándo se produjo la entrada del token de punto de control en el oplog.

        Ocultar atributos desiredTimestamp Mostrar atributos desiredTimestamp Objeto
        • fecha string(date-time)

          Fecha y hora en las que el oplog registró esta operación en la 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

        Indicador que indica si la tarea de restauración ha expirado.

      • expira en string(date-time)

        Fecha y hora en que caduca la tarea de restauración. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Fallido booleano

        Indicador que indica si la tarea de restauración falló.

      • finalizó a las string(date-time)

        Fecha y hora en que se completó la tarea de restauración. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • ID string

        string hexadecimal 24única que identifica la tarea 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 deseas restaurar este snapshot. Este parámetro expresa esta marca de tiempo en el número de segundos transcurridos desde la Unix epoch. Este número representa la primera parte de una marca de tiempo de Oplog. El recurso devuelve este parámetro cuando "deliveryType" : "pointInTime" y oplogTs supera 0.

        El valor mínimo es 1199145600.

      • puntoEnTiempoUTCSeconds integer(int32)

        Fecha y hora a partir de la cual MongoDB Cloud restauró este snapshot. Este parámetro expresa esta marca de tiempo en el número de segundos transcurridos desde la Unix epoch. El recurso devuelve este parámetro cuando "deliveryType" : "pointInTime" y pointInTimeUTCSeconds superan 0.

        El valor mínimo es 1199145600.

      • snapshotId string

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

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

      • nombreDeClusterObjetivo string Requerido

        Etiqueta legible por humanos que identifica el clúster de destino al que la tarea de restauración restaura la snapshot. 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

        string única de 24dígitos hexadecimales que identifica el Proyecto objetivo para el targetClusterName especificado.

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

      • fecha y hora string(date-time)

        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.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount está configurado en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

OBTENER /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/serverless/{clusterName}/backup/restoreJobs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
    }
  ],
  "totalCount": 42
}
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 (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"
}