Devuelve una entrada de registro comprimida (.gz) que contiene un rango de mensajes de registro para el host especificado y el Proyecto 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.
MongoDB actualiza los registros de proceso y auditoría de la infraestructura del backend del clúster cada cinco minutos. Los registros se almacenan en fragmentos de aproximadamente cinco minutos de duración, pero esta duración puede variar. Si consulta la API en busca de archivos de registro, recomendamos consultar cada cinco minutos, aunque los sondeos consecutivos podrían contener registros superpuestos. Esta función no está disponible para clústeres M0 gratuitos, M2, M5, flexibles ni sin servidor. Para usar este recurso, la cuenta de servicio o la clave de API solicitantes deben tener el rol de acceso a datos del proyecto de solo lectura o superior. 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 punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadgroupclusterlog.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api monitoringAndLogs downloadClusterLog [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endDate | Int | false | Especifica la fecha y hora del punto final del rango de mensajes de registro que se recuperarán, en segundos transcurridos desde la época UNIX. Este valor predeterminado es 24 horas después de la fecha de inicio. Si la fecha de inicio tampoco se especifica, el valor predeterminado será la hora de la solicitud. |
--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. |
--ID de grupo | 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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos". |
-h, --ayuda | false | Ayuda para descargar ClusterLog | |
--nombredelhost | string | true | Etiqueta legible por humanos que identifica el host que almacena los archivos de registro que desea descargar. |
--nombre_registro | string | true | Etiqueta legible que identifica el archivo de registro que desea devolver. Para devolver registros de auditoría, habilite la Auditoría de Base de Datos para el proyecto especificado. |
-o, --output | string | false | formato de API preferido, puede ser ["gzip"]. Este valor predeterminado es "gzip". |
--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) |
--startDate | Int | false | Especifica la fecha y hora del punto de inicio del rango de mensajes de registro que se recuperarán, en segundos transcurridos desde la época UNIX. Este valor predeterminado es 24 horas antes de la fecha de finalización. Si la fecha de finalización tampoco se especifica, el valor predeterminado es 24 horas antes de la hora de la solicitud. |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01", "2023-02-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-02-01". |
Opciones heredadas
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. |
Ejemplos
atlas api monitoringAndLogs downloadClusterLog --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200