Devolver todos los trabajos de restauración de copias de seguridad heredadas Obsoleto

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

Devuelve todas las tareas de restauración de respaldos heredados para un clúster en el Proyecto especificado. Para utilizar este recurso, la Cuenta de servicio solicitante o la API Key debe tener el rol Project Read Only.

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 copias 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 copias de seguridad heredadas existentes siguen disponibles. Caducan con el tiempo según su política de retención. Su política de copias de seguridad se restablece a la programación predeterminada. Si tenía una política de copias de seguridad personalizada implementada con copias de seguridad heredadas, debe volver a crearla siguiendo el procedimiento descrito en la documentación de Cloud Backup. Si usa el parámetro de consulta BATCH-ID, puede recuperar todos los trabajos de restauración del lote especificado. Al crear un trabajo de restauración para un clúster fragmentado, MongoDB Cloud crea un trabajo independiente para cada fragmento, además de otro para el servidor de configuración. Cada uno de estos trabajos forma parte de un lote. Sin embargo, un lote no puede incluir un trabajo de restauración para un conjunto de réplicas.

Documentación de copia de seguridad en la nube

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 el clúster con la snapshot que deseas devolver.

    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
  • batchId string

    string única de 24 dígitos hexadecimales que identifica el agrupar de tareas de restauración que se devolverán. Marca de tiempo en formato de fecha y hora ISO 8601 en UTC al crear una tarea de restauración para un clúster particionado, la aplicación crea una tarea separada para cada partición, además de otra para el host de configuración. Cada una de estas tareas forman un lote. Una tarea de restauración para un set de réplicas no puede formar parte de un lote.

    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
    • 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
      • batchId string

        Cadena única de dígitos hexadecimales 24que identifica el lote al que pertenece este trabajo de restauración. Este parámetro solo existe para restauraciones de clústeres fragmentados.

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

      • clusterId string

        Cadena hexadecimal única 24que identifica el clúster con la instantánea que desea devolver. Este parámetro se devuelve para los clústeres de restauración.

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

      • Nombre del clúster string

        Etiqueta legible por humanos que identifica el clúster que contiene las instantáneas que desea recuperar.

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

      • creado string(date-time)

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

      • entrega Objeto Requerido

        Método y detalles que indican cómo entregar los datos de la snapshot restaurada.

        Ocultar atributos de entrega Mostrar atributos de entrega Objeto
        • encabezado de autorización string

          Nombre del encabezado que se debe usar al descargar la restauración, se usa con "delivery.methodName" : "HTTP".

        • authValue string

          Valor del encabezado a utilizar al descargar la restauración, usado con "delivery.methodName" : "HTTP".

        • horas de caducidad integer(int32)

          Número de horas después de que se complete la tarea de restauración que indica cuándo expira el Localizador uniforme de recursos (URL) para el archivo de descarga de la snapshot. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

          El valor mínimo es 1.

        • expira string(date-time)

          Fecha y hora en que el Localizador uniforme de recursos (URL) del archivo para descargar del snapshot caduca. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

        • maxDownloads integer(int32)

          Entero positivo que indica cuántas veces se puede usar el Localizador Uniforme de Recursos (URL) para el archivo de descarga de instantáneas. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

          El valor mínimo es 1.

        • nombreDeMétodo string Requerido

          Etiqueta legible por humanos que identifica los medios para entregar los datos. Si configura "delivery.methodName" : "AUTOMATED_RESTORE", también debe configurar: delivery.targetGroupId y delivery.targetClusterName o delivery.targetClusterId. La respuesta devuelve "delivery.methodName" : "HTTP" ya que una restauración automatizada utiliza el Protocolo de transferencia de hipertexto (HTTP) para entregar la tarea de restauración al host objetivo.

          Los valores son CLIENT_PIT_HTTP, QUERY, AUTOMATED_RESTORE, HTTP, THIRD_PARTY_COPY, CLIENT_PIT_SCP o SCP.

        • nombreDeEstado string

          Estado del archivo de instantánea descargable cuando MongoDB Cloud recibió esta solicitud.

          Los valores son NOT_STARTED, IN_PROGRESS, READY, FAILED, INTERRUPTED, EXPIRED, MAX_DOWNLOADS_EXCEEDED o PENDING.

        • targetClusterId string

          Cadena 24única de dígitos hexadecimales que identifica el clúster de destino. Use el clusterId devuelto en el cuerpo de la respuesta de los extremos Obtener todas las instantáneas y Obtener una instantánea. Este parámetro se aplica "delivery.methodName" : "AUTOMATED_RESTORE" cuando.

          Si el clúster de destino no tiene habilitada la copia de seguridad, dos recursos devuelven parámetros con valores vacíos:

          • El punto final Obtenertodas las instantáneas devuelve una matriz de resultados vacía sin clusterId elementos
          • Obtener un punto final de clusterId instantánea no devuelve un parámetro.

          Para devolver una respuesta con el parámetro clusterId, se puede utilizar el parámetro delivery.targetClusterName o activar la copia de seguridad en el clúster de destino.

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

        • nombreDeClusterObjetivo string

          Etiqueta legible por humanos que identifica el clúster de destino. Utiliza el clusterName que hayas obtenido en el cuerpo de respuesta de los endpoints Get All Snapshots y Get a Snapshot. Este parámetro se aplica cuando "delivery.methodName" : "AUTOMATED_RESTORE".

          Si el clúster de destino no tiene habilitada la copia de seguridad, dos recursos devuelven parámetros con valores vacíos:

          • El punto final Obtenertodas las instantáneas devuelve una matriz de resultados vacía sin clusterId elementos
          • Obtener un punto final de clusterId instantánea no devuelve un parámetro.

          Para devolver una respuesta con el parámetro clusterId, se puede utilizar el parámetro delivery.targetClusterName o activar la copia de seguridad en el clúster de destino.

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

        • ID de grupo objetivo string

          string única de dígitos hexadecimales 24que identifica el Proyecto que contiene el clúster de destino para la tarea de restauración. El recurso devuelve este parámetro cuando "delivery.methodName" : "AUTOMATED_RESTORE".

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

        • URL string Obsoleto

          Localizador Uniforme de Recursos (URL) desde el cual se pueden descargar los datos del snapshot restaurado. La URL incluye la clave de verificación. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

        • urlV2 string

          Localizador Uniforme de Recursos (URL) desde el cual se pueden descargar los datos del snapshot restaurado. Esto debería ser preferido sobre url. La clave de verificación debe enviarse como un encabezado HTTP. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

      • ID de trabajo de implementación string

        string única de 24dígitos hexadecimales que identifica una tarea de implementación importada. Este parámetro existe al restaurarlo desde una snapshot/importada del clúster.

      • encryptionEnabled booleano

        Indicador que señala si alguien cifró los datos en la snapshot restaurada.

      • ID del grupo string

        Unique 24-hexadecimal digit string that identifies the Proyecto that owns the snapshots.

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

      • encriptada arreglo[objeto]

        Lista que contiene documentos que asignan cada archivo de restauración a una suma de verificación encriptada. Este parámetro se aplica después de descargar el delivery.url correspondiente. Si "methodName" : "HTTP", esta lista contiene un objeto que representa el hash del archivo .tar.gz.

        Ocultar atributos hash Mostrar atributos hashes Objeto

        Par clave y valor que asigna un archivo de restauración a una suma de verificación encriptada. Este parámetro se aplica después de descargar el/la delivery.url correspondiente.

        • fileName string

          Etiqueta legible por humanos que identifica el archivo encriptada.

        • hash string

          Suma de verificación hash que se asigna al archivo de restauración.

        • typeName string

          Etiqueta legible por humanos que identifica el algoritmo hash utilizado para calcular el valor hash.

          El valor es SHA1.

      • ID string

        string única de 24 dígitos hexadecimales que identifica la tarea de restauración.

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

      • UUID de la llave maestra cadena(uuid)

        Identificador Universalmente Único (UUID) que identifica la clave maestra KMIP (Key gestión Interoperability Protocol) utilizada para cifrar los datos de snapshot. Este parámetro solo se aplica cuando "encryptionEnabled" : "true".

      • snapshotId string

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

      • nombreDeEstado string

        etiqueta legible por humanos que identifica el estado del archivo descargable en el momento de la solicitud.

        Los valores son IN_PROGRESS, BROKEN, KILLED o FINISHED.

      • fecha y hora Objeto

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

        Ocultar atributos de marca de tiempo Mostrar atributos de marca de tiempo 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.

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

GET /api/atlas/v1.0/groups/{groupId}/clústeres/{clusterName}/restoreJobs
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/restoreJobs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "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
}
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"
}