Docs Menu
Docs Home
/ /

Lista de eventos de la API de AtlasOrgEvents

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 de la base de datos, facturación o seguridad, o cambios de estado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de miembro de la organización.

Este recurso permanece bajo revisión y puede cambiar.

Este comando se genera automáticamente y corresponde 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-listorgevents.

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis del comando
atlas api events listOrgEvents [options]
Nombre
Tipo
Requerido
Descripción

--sobre

envolvente

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.

--tipo de evento

matriz de cadenas

false

Categoría de incidente registrado en este momento.

IMPORTANTE: La lista completa de valores de tipos de eventos cambia con frecuencia.

-h, --ayuda

false

ayuda para listOrgEvents

--incluirConteo

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 sin procesar en la salida. El documento sin procesar contiene metainformación adicional sobre el evento.

--itemsPerPage

Int

false

Número de elementos que la respuesta devuelve 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 a partir de las cuales MongoDB Cloud comienza a devolver eventos. Este parámetro usa el formato de marca de tiempo 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".

--archivo de salida

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 formato prettyprint.

--versión

string

false

Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01".

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.

atlas api events listOrgEvents --version 2023-01-01 --orgId 4888442a3354817a7320eb61

Volver

listaGrupoEventos

En esta página