Devolver una tarea de restauración para un clúster

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

Devuelve una tarea de restauración de copias de seguridad en la nube para un clúster del Proyecto especificado.

Requisitos del rol
  • Administrador de copia de seguridad del proyecto

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 las tareas de restauración que desea devolver.

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

  • restoreJobId string Requerido

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

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

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.

  • bonito booleano

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

    El valor por defecto es false.

    pretty-print

Respuestas

  • 200 application/json

    OK

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

      Indicador de si una persona canceló este tarea de restauración.

    • Componentes arreglo[objeto]

      Información sobre la tarea de restauración para cada set de réplicas en el clúster.

      Ocultar atributos de componentes Mostrar los atributos de los componentes Objeto
      • downloadUrl string

        Un Localizador Uniforme de Recursos que apunta a los archivos comprimidos de la snapshot para su descarga manual. MongoDB nube devuelve este parámetro cuando "deliveryType" : "download".

      • privateDownloadDeliveryUrls arreglo[objeto]

        Uno o más Localizadores Uniformes de Recursos (URL) que apuntan a los archivos comprimidos de la snapshot para descargar manualmente y los nodos privados correspondientes. MongoDB nube devuelve este parámetro cuando "deliveryType" : "download" y la descarga se puede realizar de forma privada.

        Ocultar los atributos privateDownloadDeliveryUrls Mostrar los atributos de privateDownloadDeliveryUrls Objeto

        Un Localizador Uniforme de Recursos (URL) que apunta a los archivos comprimidos de la snapshot para la descarga manual y al punto final privado correspondiente.

        • deliveryUrl string

          Un Localizador Uniforme de Recursos que apunta a los archivos de snapshot comprimidos para descarga manual.

        • endpointId string

          string alfanumérica única de 22 caracteres que identifica el endpoint privado.

          El formato debe coincidir con el siguiente patrón: ^vpce-[0-9a-f]{17}$.

      • replicaSetName string

        Etiqueta legible por humanos que identifica el set de réplicas en el clúster.

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

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

    • expiró 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 Oplog desde el cual deseas restaurar este snapshot. Este número representa la segunda parte de una marca de tiempo de Oplog. 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.

    • privateDownloadDeliveryUrls arreglo[objeto]

      Uno o más Localizadores Uniformes de Recursos (URL) que apuntan a los archivos comprimidos de la snapshot para descargar manualmente y los nodos privados correspondientes. MongoDB nube devuelve este parámetro cuando "deliveryType" : "download" y la descarga se puede realizar de forma privada.

      Ocultar los atributos privateDownloadDeliveryUrls Mostrar los atributos de privateDownloadDeliveryUrls Objeto

      Un Localizador Uniforme de Recursos (URL) que apunta a los archivos comprimidos de la snapshot para la descarga manual y al punto final privado correspondiente.

      • deliveryUrl string

        Un Localizador Uniforme de Recursos que apunta a los archivos de snapshot comprimidos para descarga manual.

      • endpointId string

        string alfanumérica única de 22 caracteres que identifica el endpoint privado.

        El formato debe coincidir con el siguiente patrón: ^vpce-[0-9a-f]{17}$.

    • snapshotId string

      String hexadecimal única de 24 caracteres que identifica el snapshot.

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

    • targetClusterName string

      Etiqueta legible para humanos que identifica el clúster de destino al que la tarea de restauración restaura el snapshot. El recurso devuelve este parámetro cuando "deliveryType": "automated". Obligatorio para los tipos de restauración automated y pointInTime.

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

    • targetGroupId string

      string única de 24dígitos hexadecimales que identifica el proyecto de destino para el targetClusterName especificado. Requerido para los tipos de restauración automated y pointInTime.

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

    • Marca de tiempo string(date-time)

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

  • 401 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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}/clusters/{clusterName}/copia de seguridad/restoreJobs/{restoreJobId}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "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"
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}