Descarga los registros de auditoría del espacio de trabajo de procesamiento de Atlas Streams especificado.
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.
De forma predeterminada, los registros cubren periodos de 30 días. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener los roles de acceso a datos del proyecto, propietario del proyecto o propietario del procesamiento de flujos del proyecto. La API no admite llamadas directas con el esquema de respuesta JSON. Debe solicitar un esquema de respuesta gzip mediante un encabezado de aceptación con el formato: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".
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-downloadgroupstreamauditlogs.
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 downloadAuditLogs [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endDate | Int | false | Marca temporal que especifica el punto final para el rango de mensajes de registro para descargar. MongoDB Cloud expresa esta marca de tiempo en el número de segundos que han transcurrido desde la época UNIX. |
--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 | asistencia para downloadAuditLogs | |
-o, --output | string | false | formato API preferido, puede ser ["gzip"] Este valor tiene como valor predeterminado "gzip". |
--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) |
--startDate | Int | false | Marca de tiempo que especifica el punto de inicio para el rango de mensajes de registro a descargar. MongoDB Cloud expresa esta marca de tiempo en el número de segundos que han transcurrido desde la época UNIX. |
--tenantName | string | true | Etiqueta que identifica el espacio de trabajo del stream. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-02-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-02-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 streams downloadAuditLogs --version 2023-02-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]