Modifique la regla de archivado para el fichero en línea especificado de un clúster.
Para usar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave de API con el rol de Administrador de acceso a los datos del Proyecto.
Sintaxis
atlas clusters onlineArchives update <archiveId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
archiveId | string | true | Identificador único del fichero en línea a actualizar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--archiveAfter | Int | false | Número de días después de los cuales se deben archivar los datos del clúster. Mutuamente excluyente con --file. |
--clusterName | string | true | Nombre del clúster. Para obtener más información, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--expireAfterDays | Int | false | Número de días utilizados en el criterio de fecha para nominar documentos para su eliminación. Mutuamente excluyente con --file. |
--file | string | false | Ruta a un archivo de configuración JSON opcional que define la configuración de fichero en línea. Nota: los campos no compatibles en el archivo JSON se omiten. Para aprender más información sobre los archivos de configuración del fichero en linea para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. Mutuamente excluyente con --archiveAfter, --expireAfterDays. |
-h, --help | false | ayuda para actualizar | |
-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. |
--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. |
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.
Online archive '<Id>' updated.
Ejemplos
# Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json