- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Esté atento a que haya un archivo disponible.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Este comando verifica periódicamente el estado del archivo hasta que alcanza un estado distinto de PENDIENTE o EN PAUSA. Una vez que el archivo alcanza el estado esperado, el comando muestra "Archivo en línea disponible". Si se ejecuta en la terminal, se bloquea la sesión hasta que el estado del recurso cambie al estado esperado. Puede interrumpir el sondeo del comando en cualquier momento con Ctrl+C.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de solo lectura del proyecto.
Sintaxis
atlas clusters onlineArchives watch <archiveId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
archiveId | string | true | Identificador único del archivo en línea a visualizar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | false | Nombre del clúster. Para obtener más información, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-h, --ayuda | false | ayuda para el reloj | |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del 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, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
Online archive available.
Ejemplos
atlas cluster onlineArchive watch archiveIdSample --clusterName clusterNameSample