Devuelve los registros de acceso de un clúster identificado por el hostname del clúster.
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.
Los registros de acceso contienen una lista de solicitudes de autenticación realizadas contra tus clústeres. No se puede usar esta funcionalidad en clústeres de nivel inquilino (M0, M2, M5). Para utilizar este recurso, la Cuenta de Servicio solicitante o Clave API debe tener el rol de Administrador de Supervisión del Proyecto o de Administrador de Acceso a la Base de Datos del Proyecto.
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-getgroupdbaccesshistoryprocess.
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 accessTracking getAccessHistoryProcess [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--authResult | false | Indicador que señala si la respuesta solo devuelve los intentos de autenticación exitosos. | |
--end | Int | false | Fecha y hora para detener la obtención del historial de la base de datos. Si se especifica end, también se debe especificar start. Este parámetro utiliza el tiempo UNIX epoch en milisegundos. |
--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 getAccessHistoryProcess | |
--hostname | string | true | Nombre de dominio completamente calificado o dirección IP del host de MongoDB que almacena las entradas de registro que se desea descargar. |
--ipAddress | string | false | Una dirección de protocolo de Internet que intentó autenticarse con la base de datos. |
--nLogs | Int | false | Número máximo de líneas del registro a devolver. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--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) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--start | Int | false | Fecha y hora en que MongoDB la nube comienza a recuperar el historial de la base de datos. Si especificas inicio, también debes especificar fin. Este parámetro utiliza el Unix epoch en milisegundos. |
--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 accessTracking getAccessHistoryProcess --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname]