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 backend del clúster cada cinco minutos. Los registros se almacenan en fragmentos de aproximadamente cinco minutos, aunque esta duración puede variar. Si realizas consultas a la API para obtener entradas de registro, recomendamos consultarla cada cinco minutos, aunque las consultas consecutivas puedan contener algunos registros superpuestos. Esta funcionalidad no está disponible para clústeres gratuitos M0, M2, M5, flex o sin servidor. Para utilizar este recurso, la Cuenta de Servicio o la clave API solicitante debe tener el rol de Acceso de Solo Lectura a Datos de Proyecto o superior. La API no admite llamadas directas con el esquema de respuesta json. Debes solicitar un esquema de respuesta gzip utilizando un header accept 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-downloadgroupclusterlog.
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 monitoringAndLogs downloadClusterLog [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endDate | Int | false | Especifica la fecha y hora para el punto final del rango de mensajes de registro a recuperar, en el número de segundos que han transcurrido desde la Unix epoch. Este valor se establecerá por defecto en 24 horas después de la fecha de inicio. Si la fecha de inicio tampoco se especifica, el valor será, por defecto, el momento de la solicitud. |
--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 downloadClusterLog | |
--hostName | 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 por humanos que identifica la entrada de registro que deseas devolver. Para devolver los registros de auditoría, habilite Auditoría de Base de Datos para el Proyecto especificado. |
-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 | Especifica la fecha y hora para el punto de inicio del rango de mensajes de registro a recuperar, en el número de segundos transcurridos desde la Unix epoch. Este valor se establecerá por defecto como 24 horas antes de la fecha de finalización. Si la fecha de finalización tampoco se especifica, el valor será por defecto 24 horas antes del momento de la solicitud. |
--versión | string | false | versión de la api a utilizar al llamar a la llamada api [opciones: "2023-01-01", "2023-02-01"], por defecto se utilizará la última versión o el valor de configuración api_version de los perfiles si se establece. Este valor tiene como valor por defecto "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 monitoringAndLogs downloadClusterLog --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200