Devuelve los detalles del fichero en linea especificado para su clúster.
Para utilizar este comando, debes autenticarte con una cuenta de usuario, cuenta de servicio o una clave API con el rol de Lectura del proyecto.
Sintaxis
atlas clusters onlineArchives describe <archiveId> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
archiveId | string | true | Identificador único del fichero en línea que se debe recuperar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Nombre del clúster. Para aprender más, consulta https://dochub.mongodb.org/core/create-cluster-api. |
-h, --help | false | ayuda para describir | |
-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, usa 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 a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta 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.
ID CLUSTER DATABASE COLLECTION STATE <Id> <ClusterName> <DbName> <CollName> <State>
Ejemplos
# Return the JSON-formatted details for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives describe 5f189832e26ec075e10c32d3 --clusterName myCluster --output json