Retorna todos los clústeres para tu 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 list [options]
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, --help | false | ayuda para la lista | |
--limit | Int | false | Número de elementos por página de resultados, hasta un máximo de 500. Si tienes más de 500 resultados, especifica la opción --page para cambiar la página de resultados. Este valor es 100 por defecto. |
--omitCount | false | Indicador que señala si la respuesta JSON devuelve el número total de elementos (totalCount) en la respuesta JSON. | |
-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. |
--page | Int | false | Número de página que especifica una página de resultados. Este valor es por defecto 1. |
--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. |
--tier | string | false | Nivel para cada servidor que contiene datos en el clúster. Para obtener más información sobre los niveles de clúster, consulta https://dochub.mongodb.org/core/cluster-tier-atlas. |
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.
ID NAME MDB VER STATE <Id> <Name> <MongoDBVersion> <StateName>
Ejemplos
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --output json
# Return a JSON-formatted list of all clusters for the project with ID 5e2211c17a3e5a48f5497de3 and with independent shard scaling mode: atlas clusters list --projectId 5e2211c17a3e5a48f5497de3 --autoScalingMode independentShardScaling --output json