Devuelve los detalles del clúster especificado para su proyecto.
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 describe <clusterName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre del clúster | string | true | Nombre del clúster que se va a recuperar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--autoScalingMode | string | false | Modo en que el clúster escala. Los valores válidos son clusterWideScaling o independentShardScaling. Este valor se configura por defecto como "escalado a nivel de clúster". |
-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 NAME MDB VER STATE <Id> <Name> <MongoDBVersion> <StateName>
Ejemplos
# Return the JSON-formatted details for the cluster named myCluster: atlas clusters describe myCluster --output json