Devolver todas las snapshot de respaldos heredados Obsoleto

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

Devuelve todas las instantáneas de copia de seguridad heredadas de un clúster en el proyecto especificado. A partir del 23 de marzo de 2020, todos los nuevos clústeres solo pueden utilizar Copias de Seguridad en la Nube. Cuando mejoras a 4.2, tu sistema de copia de seguridad se mejora a copia de seguridad en la nube si actualmente está configurado como respaldo heredado. Después de esta actualización, todas sus instantáneas de respaldo heredadas existentes permanecerán disponibles. Expiran con el tiempo de acuerdo con su política de retención. Su política de copia de seguridad se restablece al cronograma por defecto. Si tenías una política de respaldo personalizada vigente con respaldos heredados, debes crearla nuevamente siguiendo el procedimiento descrito en la documentación de Cloud Backup.

Requisitos del rol
  • Proyecto de solo lectura
Documentación de copias 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.

    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

    Indicador que señala 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 por defecto 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.

    pretty-print
  • completado string

    Etiqueta legible por humanos que especifica si se deben devolver solo las instantáneas completadas, incompletas o todas. Por defecto, MongoDB Cloud sólo devuelve instantáneas completadas.

    Los valores son all, true o false. El valor por defecto es true.

Respuestas

  • 200 application/json

    OK

    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 los atributos de resultados Mostrar los atributos de los resultados Objeto
      • clusterId string

        string única de dígitos hexadecimales 24que identifica el clúster con los snapshots que deseas devolver.

        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.

      • completo booleano

        Indicador que informa si la snapshot existe. Este indicador devuelve false mientras MongoDB nube crea el snapshot.

      • creado Objeto

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

        Ocultar atributos creados Mostrar los atributos creados 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.

      • doNotDelete booleano

        Bandera que indica si alguien puede borrar esta instantánea. No se puede establecer "doNotDelete" : true y configurar una marca de tiempo para caducidad en la misma solicitud.

      • expira string(date-time)

        Fecha y hora en que MongoDB nube borra el snapshot. Si "doNotDelete" : true, MongoDB nube remueve cualquier valor establecido para este parámetro. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

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

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

      • incremental booleano

        Indicador que expresa si la snapshot es incremental o completa.

      • lastOplogAppliedTimestamp Objeto

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

        Ocultar los atributos de lastOplogAppliedTimestamp Mostrar los atributos lastOplogAppliedTimestamp 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.

      • piezas arreglo[objeto]

        Metadatos que describen la snapshot completa.

        • Para un set de réplicas, este arreglo contiene un solo documento.
        • Para un clúster, este arreglo contiene un documento para cada partición más un documento para el host de configuración.
        Ocultar atributos de partes Mostrar atributos de piezas Objeto

        Características que identifican este snapshot.

        • clusterId string

          string única de dígitos hexadecimales 24que identifica el clúster con los snapshots que deseas devolver.

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

        • completedTime string(date-time)

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

        • compressionSetting string

          Etiqueta legible para humanos que identifica el método de compresión de la snapshot.

          Los valores son NONE o GZIP.

        • dataSizeBytes integer(int64)

          Tamaño total de los datos almacenados en cada nodo del clúster. Este parámetro expresa su valor en bytes.

        • encryptionEnabled booleano

          Indicador que identifica si alguien cifró este snapshot.

        • compatibilidad de características entre versiones string

          Número que indica la compatibilidad de características entre versiones de MongoDB que ejecutó el nodo primario del set de réplicas cuando MongoDB Cloud creó la snapshot.

        • fileSizeBytes integer(int64)

          Número que indica el tamaño total de los archivos de datos en bytes.

        • machineId string

          Nombre del host y puerto que indican el nodo en el que MongoDB nube creó la snapshot.

          El formato debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

        • UUID de la llave maestra string(uuid)

          string única que identifica la clave maestra de interoperabilidad de gestión de claves (KMIP) utilizada para cifrar los datos del snapshot. El recurso devuelve este parámetro cuando "parts.encryptionEnabled" : true.

        • mongodVersion string

          Número que indica la versión de MongoDB que el primario del set de réplicas ejecutaba cuando MongoDB Cloud creó la snapshot.

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

        • replicaSetName string

          Etiqueta legible por humanos que identifica el conjunto de réplicas.

        • replicaState string

          El rol del nodo en el momento en que comenzó el proceso de snapshot.

        • storageSizeBytes integer(int64)

          Número que indica el tamaño total del espacio asignado para el almacenamiento de documentos.

        • typeName string

          Etiqueta legible para humanos que identifica el tipo de servidor desde el cual MongoDB nube tomó este snapshot.

          Los valores son REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET o CONFIG_SHARD_REPLICA_SET.

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

  • 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}/snapshots
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/snapshots' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "clusterName": "string",
      "complete": true,
      "created": {
        "date": "2026-05-04T09:42:00Z",
        "increment": 1199145600
      },
      "doNotDelete": true,
      "expires": "2026-05-04T09:42:00Z",
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "incremental": true,
      "lastOplogAppliedTimestamp": {
        "date": "2026-05-04T09:42:00Z",
        "increment": 1199145600
      },
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "parts": [
        {
          "clusterId": "32b6e34b3d91647abb20e7b8",
          "completedTime": "2026-05-04T09:42:00Z",
          "compressionSetting": "NONE",
          "dataSizeBytes": 42,
          "encryptionEnabled": true,
          "fcv": "string",
          "fileSizeBytes": 42,
          "machineId": "string",
          "masterKeyUUID": "string",
          "mongodVersion": "string",
          "replicaSetName": "string",
          "replicaState": "string",
          "storageSizeBytes": 42,
          "typeName": "REPLICA_SET"
        }
      ]
    }
  ],
  "totalCount": 42
}
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"
}