Devuelve los detalles de un clúster efÃmero de Atlas.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Para obtener más información sobre los clústeres efÃmeros, consulte la sección "Crear un clúster efÃmero de Atlas" en la documentación de MongoDB Atlas.
Este comando se genera automáticamente y corresponde a 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getephemeralcluster..
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api ephemeralClusters getEphemeralCluster [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterId | string | true | Identificador único del clúster efÃmero que se desea consultar. |
-h, --help | false | Ayuda para obtener EphemeralCluster | |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON". |
--outputFile | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--versión | string | false | Versión de la API a utilizar al llamar a los endpoints de la API Atlas [opciones: "preview"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se configura por defecto como "previsualización". |
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. |