Descarga los registros operativos para el área de trabajo de procesamiento de flujos de Atlas o procesador de flujo especificados.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Por defecto, los registros cubren periodos de 30 días. Para utilizar este recurso, la cuenta de servicio solicitante o la clave de API deben tener los roles de acceso a los datos del Proyecto, Propietario del Proyecto o Propietario de Stream Processing del Proyecto. La API no admite llamadas directas con el esquema de respuesta json. Debes hacer una solicitud de un esquema de respuesta gzip utilizando un encabezado de aceptación con el formato: "Accept: application/vnd.atlas.2025-03-12+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/operación/operación-downloadgroupstreamoperationallogs.
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 downloadOperationalLogs [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 señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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 | string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/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 downloadOperationalLogs | |
-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) |
--spName | string | false | Nombre del procesador de flujos para descargar registros. Una string vacía descargará los registros de todos los procesadores de flujos del espacio de trabajo. |
--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 flujo. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2025-03-12"], 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 "2025-03-12". |
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 downloadOperationalLogs --version 2025-03-12 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]