Modifique la programación de copias de seguridad para el clúster especificado para su proyecto.
El cronograma de copias de seguridad define cuándo MongoDB toma instantáneas programadas y durante cuánto tiempo almacena esas instantáneas.
Para usar este comando, debes autenticarte con una cuenta de usuario, una cuenta de servicio o una clave API que tenga el rol de Propietario del proyecto.
Sintaxis
atlas backups schedule update [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--autoExport | false | Indicador que permite la exportación automática de instantáneas de copias de seguridad en la nube al bucket de AWS. Mutuamente excluyente con --noAutoExport, --file. | |
--clusterName | string | true | Nombre del clúster. Para obtener más información, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--exportBucketId | string | false | Identificador único que Atlas asigna al bucket. Mutuamente excluyente con --file. |
--exportFrequencyType | string | false | Frecuencia asociada a la política de exportación. El valor puede ser diario, semanal o mensual. Mutuamente excluyente con --file. |
-f, --file | string | false | Ruta a un archivo de configuración JSON opcional que define la configuración del cronograma de copia de seguridad. Para obtener información sobre el archivo de configuración de copia de seguridad en la nube para la Atlas CLI, consulte https://dochub.mongodb.org/core/cloud-backup-config-file. Mutuamente excluyente con --exportBucketId, --exportFrequencyType, --referenceHourOfDay, --referenceMinuteOfHour, --restoreWindowDays, --autoExport, --noAutoExport, --updateSnapshots, --noUpdateSnapshots, --useOrgAndGroupNamesInExportPrefix, --noUseOrgAndGroupNamesInExportPrefix, --policy. |
-h, --help | false | ayuda para actualizar | |
--noAutoExport | false | Indicador que desactiva la exportación automática de snapshot de copias de seguridad en la nube al bucket de AWS. Mutuamente excluyente con --autoExport, --archivo. | |
--noUpdateSnapshots | false | Bandera que desactiva aplicar los cambios de retención en la política de copia de seguridad a los snapshots que Atlas tomó previamente. Mutuamente excluyente con --updateSnapshots, --archivo. | |
--noUseOrgAndGroupNamesInExportPrefix | false | Marcador que desactiva el uso de nombres de organización y proyecto en lugar de los UUID de organización y proyecto en la ruta de los archivos de metadatos que Atlas carga en tu bucket de S3 después de terminar de exportar las instantáneas. Mutuamente excluyente con --useOrgAndGroupNamesInExportPrefix, --archivo. | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--policy | stringArray | false | Arreglo que contiene un documento para cada elemento de la política de copia de seguridad en la política de copia de seguridad actualizada deseada. Se debe especificar en un formato: "--policy policyID,policyItemID,frequencyType,frequencyIntervalNumber,retentionUnit,retentionValue". Mutuamente excluyente con --file. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
--referenceHourOfDay | Int | false | Hora del día para programar instantáneas usando un reloj de 24 horas. Los valores aceptados están entre 0 y 23, inclusive. Mutuamente excluyente con --file. |
--referenceMinuteOfHour | Int | false | Minuto de la hora para programar snapshots. Los valores aceptados están entre 0 y 59 inclusive. Mutuamente excluyente con --file. |
--restoreWindowDays | Int | false | Número de días atrás que se pueden restaurar con la precisión de la copia de seguridad continua en la nube. Debe ser un entero positivo distinto de cero. Aplica solo a las copias de seguridad continuas en la nube. Mutuamente excluyente con --file. |
--updateSnapshots | false | Bandera que permite aplicar los cambios de retención de la política de copia de seguridad actualizada a los snapshots que Atlas tomó previamente. Mutuamente excluyente con --noUpdateSnapshots, --archivo. | |
--useOrgAndGroupNamesInExportPrefix | false | Indicador que permite el uso de nombres de organización y proyecto en lugar de UUIDs de organización y proyecto en la ruta de los archivos de metadatos que Atlas sube a tu bucket S3 después de terminar de exportar los snapshots. Mutuamente excluyente con --noUseOrgAndGroupNamesInExportPrefix, --archivo. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
Snapshot backup policy for cluster '<ClusterName>' updated.
Ejemplos
# Update a snapshot backup policy for a cluster named Cluster0 to back up snapshots every 6 hours and, retain for 7 days, and update retention of previously-taken snapshots: atlas backup schedule update --clusterName Cluster0 --updateSnapshots --policy 62da8faac84a2721e448d767,62da8faac84a2721e448d768,hourly,6,days,7
# Update a snapshot backup policy for a cluster named Cluster0 to export snapshots monthly to an S3 bucket: atlas backup schedule update --clusterName Cluster0 --exportBucketId 62c569f85b7a381c093cc539 --exportFrequencyType monthly