- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Devuelve la cadena de conexión SRV para el clúster que especifique.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de solo 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 Atlas para el que desea recuperar cadenas de conexión. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-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. |
--type | string | false | Tipo de cadena de conexión. Si especifica "private", esta opción recupera la cadena de conexión del punto final de interconexión de red. Si especifica "privateEndpoint", esta opción recupera las cadenas de conexión optimizadas para los fragmentos de los puntos finales privados. El valor predeterminado es "standard". |
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. |
Ejemplos
# Return the JSON-formatted connection strings for the cluster named myCluster: atlas clusters connectionStrings describe myCluster --output json