Restaurar una copia de seguridad en la nube de un clúster fragmentado

OBTENER /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}

Devuelve una snapshot de un clúster fragmentado del Proyecto especificado.

Requisitos del rol
  • Proyecto de solo lectura

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.

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

  • snapshotId string Requerido

    string única de 24 dígitos hexadecimales que identifica la instantánea deseada.

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

      Describe el tipo de servidor de configuración de un clúster particionado.

      Los valores son EMBEDDED o DEDICATED.

    • creado a las string(date-time)

      Fecha y hora cuando MongoDB nube tomó el snapshot. Este parámetro expresa su valor en el formato de marca temporal ISO 8601 en UTC.

    • Descripción string

      Frase o oración legible que explique el propósito del snapshot. El recurso devuelve este parámetro cuando "status": "onDemand".

    • expira en string(date-time)

      Fecha y hora en que MongoDB nube borra el snapshot. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • frequencyType string

      Etiqueta legible por humanos que identifica la frecuencia con la que se activa este snapshot.

      Los valores son hourly, daily, weekly, monthly o yearly.

    • ID string

      string única de 24dígitos hexadecimales que identifica la snapshot.

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

    • UUID de la llave maestra string(uuid)

      Cadena única que identifica la llave maestra de cliente (llave maestra de cliente) del Servicio de administración de claves (KMS) de Amazon Web Services (AWS) utilizada para cifrar la snapshot. El recurso devuelve este valor cuando "encryptionEnabled" : true.

    • nodo arreglo[objeto]

      Lista que incluye los snapshots y el proveedor de nube que almacena los snapshots. El recurso devuelve este parámetro cuando "type" : "SHARDED_CLUSTER".

      Ocultar los atributos de los nodos Mostrar atributos de los nodos Objeto
      • Proveedor de nube string Requerido

        Etiqueta legible por humanos que identifica al proveedor de nube.

        Los valores son AWS, AZURE o GCP.

      • ID string Requerido

        string única de 24dígitos hexadecimales que identifica la snapshot.

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

      • replicaSetName string Requerido

        Etiqueta legible por humanos que identifica la partición o el host de configuración de donde MongoDB nube tomó esta snapshot.

    • mongodVersion string

      Versión del host de MongoDB que esta snapshot respalda.

      El formato debe coincidir con el siguiente patrón: ([\d]+\.[\d]+\.[\d]+).

    • policyItems array[string]

      Lista que contiene identificadores únicos para los elementos de la política.

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

    • snapshotIds array[string]

      Lista que contiene los identificadores únicos de los snapshots creados para las particiones y el host de configuración en un clúster particionado. El recurso devuelve este parámetro cuando "type": "SHARDED_CLUSTER". Estos identificadores deben coincidir con los especificados en nodos[n].id parámetros. Esto permite mapear una snapshot a su partición o nombre de host de configuración.

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

    • snapshotType string

      Etiqueta legible por humanos que identifica cuándo se activa esta snapshot.

      Los valores son onDemand, scheduled o fallback.

    • Estado string

      Etiqueta legible por humanos que indica la etapa del proceso de copia de seguridad de esta snapshot.

      Los valores son queued, inProgress, completed o failed.

    • storageSizeBytes integer(int64)

      Cantidad de bytes necesarios para almacenar la copia de seguridad en el momento de la snapshot.

    • tipo string

      Etiqueta legible por humanos que categoriza el clúster como un set de réplicas o un clúster fragmentado.

      Los valores son replicaSet o shardedCluster.

  • 400 application/json

    Solicitud incorrecta.

    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.

  • 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}/backup/snapshots/shardedCluster/{snapshotId}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "configServerType": "EMBEDDED",
  "createdAt": "2026-05-04T09:42:00Z",
  "description": "string",
  "expiresAt": "2026-05-04T09:42:00Z",
  "frequencyType": "hourly",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "masterKeyUUID": "string",
  "members": [
    {
      "cloudProvider": "AWS",
      "id": "32b6e34b3d91647abb20e7b8",
      "replicaSetName": "string"
    }
  ],
  "mongodVersion": "string",
  "policyItems": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "snapshotType": "onDemand",
  "status": "queued",
  "storageSizeBytes": 42,
  "type": "replicaSet"
}
Ejemplos de respuesta (400)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
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"
}