Devuelve la cadena de conexión SRV para el clúster que especifiques.
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 connectionStrings describe <clusterName> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre del clúster | string | true | Nombre del clúster de Atlas para el que desea recuperar cadenas de conexión. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-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, use 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. |
--type | string | false | Tipo de cadena de conexión. Si especificas 'privado', esta opción recupera la cadena de conexión para el punto final de emparejamiento de red. Si especificas "privateEndpoint", esta opción recupera las cadenas de conexión optimizadas por particiones para los nodos privados. Este valor se ajusta por defecto a "estándar". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# Return the JSON-formatted connection strings for the cluster named myCluster: atlas clusters connectionStrings describe myCluster --output json