Devuelve el ID de la cuenta y el ID de la VPC para el grupo y la región especificados.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. 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.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operación-getgroupstreamaccountdetails.
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 streams getAccountDetails [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--cloudProvider | string | true | Uno de "aws", "azure" o "gcp". |
--envelope | envelope | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
--groupId | string | true | Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/groups](#tag/Projects/operation/listProjects) para recuperar todos los proyectos a los que el usuario autenticado tiene acceso. NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos. |
-h, --help | false | ayuda para getAccountDetails | |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado 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) |
--nombreDeRegión | string | true | El nombre específico de la región del proveedor de nubes, es decir, "US_EAST_1" para el proveedor de nubes "aws". |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2024-11-13"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2024-11-13". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName]