Devuelve un archivo de registro comprimido (.gz) que contiene un rango de mensajes de registro para el host especificado y el proyecto especificado. MongoDB actualiza los registros de proceso y auditoría de la infraestructura del backend del clúster cada cinco minutos. Los registros se almacenan en fragmentos de aproximadamente cinco minutos de duración, pero esta duración puede variar. Si consulta la API en busca de archivos de registro, recomendamos consultar cada cinco minutos, aunque los sondeos consecutivos podrían contener registros superpuestos. Esta función no está disponible para clústeres gratuitos M0, M2, M5, flexibles ni sin servidor. Para usar este recurso, la cuenta de servicio o la clave de API solicitantes deben tener el rol de Visor de registros del clúster del proyecto o el rol de Solo lectura de acceso a datos del proyecto. 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. Versiones obsoletas: v2-{2023-01-01}
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups 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".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica el host que almacena los archivos de registro que desea descargar.
El formato debe coincidir con el siguiente patrón:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$. -
Etiqueta legible que identifica el archivo de registro que desea devolver. Para devolver registros de auditoría, habilite la Auditoría de Base de Datos para el proyecto especificado.
Los valores son
mongodb,mongos,mongodb-audit-logomongos-audit-log.Configurar la auditoría de bases de datos
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. 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 encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Especifica la fecha y hora del punto final del rango de mensajes de registro que se recuperarán, en segundos transcurridos desde la época UNIX. Este valor predeterminado es 24 horas después de la fecha de inicio. Si la fecha de inicio tampoco se especifica, el valor predeterminado será la hora de la solicitud.
El valor mínimo es
1199145600. -
Especifica la fecha y hora del punto de inicio del rango de mensajes de registro que se recuperarán, en segundos transcurridos desde la época UNIX. Este valor predeterminado es 24 horas antes de la fecha de finalización. Si la fecha de finalización tampoco se especifica, el valor predeterminado es 24 horas antes de la hora de la solicitud.
El valor mínimo es
1199145600.
atlas api monitoringAndLogs downloadClusterLog --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241113001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.DownloadGroupClusterLogApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
DownloadGroupClusterLogWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-11-13+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-11-13+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}