Devuelve eventos para la organización especificada.
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.
Los eventos identifican actividades significativas o cambios de estado en la base de datos, la facturación o la seguridad. Para utilizar este recurso, la cuenta de servicio solicitante o la clave API deben tener el rol de miembro de la organización.
Este recurso sigue en proceso de revisión y puede cambiar.
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/operation/operation-listorgevents.
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 events listOrgEvents [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--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. |
--tipoEvento | stringArray | false | Categoría del incidente registrada en este momento. IMPORTANTE: La lista completa de valores de tipos de eventos cambia con frecuencia. |
-h, --help | false | ayuda para listOrgEvents | |
--includeCount | false | Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta. | |
--includeRaw | false | Indicador que indica si se debe incluir el documento original en la salida. El documento bruto contiene información meta adicional sobre el evento. | |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
--maxDate | string | false | Fecha y hora a partir de la cual MongoDB nube deja de devolver eventos. Este parámetro utiliza el formato de marca de tiempo ISO 8601 en UTC. |
--minDate | string | false | Fecha y hora desde cuando MongoDB nube empieza a devolver eventos. Este parámetro utiliza el formato de marca temporal ISO 8601 en UTC. |
--orgId | string | true | Cadena única de dígitos hexadecimales 24que identifica la organización que contiene sus proyectos. Utilice el punto de conexión [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-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) |
--número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], 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 "2023-01-01". |
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 events listOrgEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61