Actualizar la fecha de vencimiento de una instantánea de copia de seguridad heredada Obsoleto

PARCHE /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/instantáneas/{ID de instantánea}

Cambia la fecha de vencimiento de una instantánea de copia de seguridad heredada para un clúster del proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto. 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 está configurado como copia de seguridad heredada. Después de esta actualización, todas sus instantáneas de copia 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 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.

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

  • snapshotId string Requerido

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

    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
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Cambia la expiración de una instantánea de copia de seguridad heredada.

  • NoEliminar booleano

    Marca que indica si se puede eliminar esta instantánea. No se puede establecer "doNotDelete" : true y una marca de tiempo para las fechas de caducidad en la misma solicitud.

  • expira cadena(fecha-hora)

    Fecha y hora en que MongoDB Cloud elimina la instantánea. Si es "doNotDelete" : true, MongoDB Cloud elimina cualquier valor establecido para este parámetro. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

Respuestas

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

    Vale

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

    • completar booleano

      Indicador que indica si la instantánea existe. Este indicador devuelve false mientras MongoDB Cloud crea la instantánea.

    • creado 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 creados Mostrar atributos creados 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.

    • NoEliminar booleano

      Marca que indica si se puede eliminar esta instantánea. No se puede establecer "doNotDelete" : true y una marca de tiempo para las fechas de caducidad en la misma solicitud.

    • expira cadena(fecha-hora)

      Fecha y hora en que MongoDB Cloud elimina la instantánea. Si es "doNotDelete" : true, MongoDB Cloud elimina 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 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})$.

    • ID. string

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

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

    • incremental booleano

      Bandera que indica si se trata de una instantánea incremental o completa.

    • última marca de tiempo aplicada del registro de operaciones 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 los atributos de lastOplogAppliedTimestamp Mostrar los atributos de lastOplogAppliedTimestamp 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.

    • partes matriz[objeto]

      Metadatos que describen la instantánea completa.

      • Para un conjunto de réplicas, esta matriz contiene un solo documento.
      • Para un clúster fragmentado, esta matriz contiene un documento para cada fragmento más un documento para el host de configuración.

      Características que identifican esta instantánea.

      Ocultar atributos de las piezas Mostrar atributos de las piezas 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})$.

      • tiempo completado cadena(fecha-hora)

        Fecha y hora de finalización de la instantánea. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • Ajuste de compresión string

        Etiqueta legible por humanos que identifica el método de compresión de la instantánea.

        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 se expresa en bytes.

      • encryptionEnabled booleano

        Bandera que indica si alguien cifró esta instantánea.

      • FCV string

        Número que indica la versión de compatibilidad de características de MongoDB que el conjunto de réplicas principal ejecutó cuando MongoDB Cloud creó la instantánea.

      • bytes de tamaño de archivo integer(int64)

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

      • Identificación de la máquina string

        Nombre de host y puerto que indican el nodo en el que MongoDB Cloud creó la instantánea.

        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 clave maestra cadena(uuid)

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

      • Versión de mongod string

        Número que indica la versión de MongoDB que el conjunto de réplicas principal ejecutó cuando MongoDB Cloud creó la instantánea.

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

      • nombreConjuntoRéplica string

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

      • Estado de réplica string

        El papel del nodo en el momento en que comenzó el proceso de instantánea.

      • bytes de tamaño de almacenamiento integer(int64)

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

      • tipoNombre string

        Etiqueta legible por humanos que identifica el tipo de servidor desde el cual MongoDB Cloud tomó esta instantánea.

        Los valores son REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET o CONFIG_SHARD_REPLICA_SET.

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

PARCHE /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/instantáneas/{ID de instantánea}
atlas api legacyBackup updateClusterSnapshot --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/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.UpdateGroupClusterSnapshotApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		UpdateGroupClusterSnapshotWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "doNotDelete": true,
  "expires": "2026-05-04T09:42:00Z"
}
Ejemplos de respuestas (200)
{
  "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"
    }
  ]
}
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"
}