Descarga los registros de consultas para la instancia de base de datos federada 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.
Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener los roles de propietario del proyecto o acceso a datos del proyecto (lectura y escritura). 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-downloadgroupdatafederationquerylogs.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api dataFederation downloadFederationQueryLogs [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--endDate | Int | false | Marca de tiempo que especifica el punto final del rango de mensajes de registro que se descargarán. MongoDB Cloud expresa esta marca de tiempo en segundos transcurridos desde la época UNIX. |
--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 FederationQueryLogs | |
-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 | Marca de tiempo que especifica el punto de inicio del rango de mensajes de registro que se descargarán. MongoDB Cloud expresa esta marca de tiempo en segundos transcurridos desde la época UNIX. |
--tenantName | string | true | Etiqueta legible por humanos que identifica la instancia de base de datos federada para la que desea descargar registros de consultas. |
--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". |
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 dataFederation downloadFederationQueryLogs --version 2023-01-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]