Descarga los registros de query de la instancia federada de base de datos especificada.
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.
Para utilizar este recurso, la Cuenta de Servicio solicitante o la Clave API debe tener los roles de Propietario del Proyecto o acceso a los datos de lectura y escritura del Proyecto. La API no admite llamadas directas con el esquema de respuesta json. Debes solicitar un esquema de respuesta gzip utilizando un encabezado de aceptación en 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/operación/operación-downloadgroupdatafederationquerylogs.
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 dataFederation downloadFederationQueryLogs [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. |
--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 downloadFederationQueryLogs | |
-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 legible por humanos que identifica la instancia federada de base de datos para la que desea descargar registros de consultas. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-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-01-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 dataFederation downloadFederationQueryLogs --version 2023-01-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]