Devolver un trabajo de restauración de copia de seguridad heredado Obsoleto

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/restoreJobs/{ID del trabajo}

Devuelve una tarea de restauración de respaldo heredado 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 podrán 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 está configurado con copias de seguridad heredadas. Después de esta actualización, todas sus instantáneas de copias de seguridad heredadas existentes seguirán 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 con copias de seguridad heredadas, debe volver a crearla siguiendo el procedimiento descrito en la documentación de Copia de seguridad en la nube.

Documentación de copia de seguridad en la nube

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 el clúster con la instantánea que desea devolver.

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

  • ID de trabajo string Requerido

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

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

Respuestas

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

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID de lote 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 cadena(fecha-hora)

      Fecha y hora en que se solicitó este trabajo 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 utilizará al descargar la restauración, utilizado con "delivery.methodName" : "HTTP".

      • valor de autorización string

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

      • horas de vencimiento integer(int32)

        Número de horas tras la finalización del trabajo de restauración que indica cuándo caduca el Localizador Uniforme de Recursos (URL) del archivo de descarga de la instantánea. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP".

        El valor mínimo es 1.

      • expira cadena(fecha-hora)

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

      • Descargas máximas 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 que identifica el medio de entrega de los datos. Si se establece "delivery.methodName" : "AUTOMATED_RESTORE", también se deben establecer delivery.targetGroupId y delivery.targetClusterName o delivery.targetClusterId. La respuesta devuelve "delivery.methodName" : "HTTP", ya que una restauración automatizada utiliza el Protocolo de Transporte de Hipertexto (HTTP) para entregar el trabajo de restauración al host de destino.

        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.

      • ID de clúster objetivo 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, utilice el parámetro delivery.targetClusterName o habilite 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 que identifica el clúster de destino. Use el clusterName valor devuelto en el cuerpo de la respuesta de los puntos de conexión 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, utilice el parámetro delivery.targetClusterName o habilite 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 que se pueden descargar los datos de la instantánea restaurada. 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 que se pueden descargar los datos de la instantánea restaurada. Se recomienda usar este parámetro en lugar de url. La clave de verificación debe enviarse como encabezado HTTP. El recurso devuelve este parámetro cuando "delivery.methodName" : "HTTP" es válido.

    • ID de trabajo de implementación string

      Cadena hexadecimal única 24que identifica un trabajo de implementación importado. Este parámetro existe al restaurar desde una instantánea/captura de clúster importada.

    • encryptionEnabled booleano

      Bandera que indica si alguien cifró los datos en la instantánea restaurada.

    • ID de grupo string

      Cadena de dígitos hexadecimales 24única que identifica el proyecto que posee las instantáneas.

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

    • hashes matriz[objeto]

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

      Par clave-valor que asigna un archivo de restauración a una suma de comprobación hash. Este parámetro se aplica después de descargar el delivery.url correspondiente.

      Ocultar atributos hash Mostrar atributos hashes Objeto
      • fileName string

        Etiqueta legible por humanos que identifica el archivo hash.

      • hash string

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

      • tipoNombre string

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

        El valor es SHA1.

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

    • UUID de clave maestra cadena(uuid)

      Identificador Único Universal (UUID) que identifica la clave maestra de Interoperabilidad de Administración de Claves (KMIP) utilizada para cifrar los datos de la instantánea. 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

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

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

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

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

OBTENER /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/restoreJobs/{ID del trabajo}
atlas api legacyBackup getClusterRestoreJob --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20230201001/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.GetGroupClusterRestoreJobApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		GetGroupClusterRestoreJobWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-02-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true"
Ejemplos de respuestas (200)
{
  "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
  }
}
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"
}