Devuelve los detalles del clúster especificado para tu proyecto.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con la función de solo lectura del proyecto.
Sintaxis
atlas clusters describe <clusterName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
nombre del clúster | string | true | Nombre del cluster a recuperar. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--autoScalingMode | string | false | Modo de escalado del clúster. Los valores válidos son clusterWideScaling o independentShardScaling. El valor predeterminado es "clusterWideScaling". |
-h, --ayuda | 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, use la opción -o json. |
--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 para 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.
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