Descarga los registros de consultas del archivo en línea especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol "Acceso a datos del proyecto de solo lectura" o superior. La API no admite llamadas directas con el esquema de respuesta JSON. Debe solicitar un esquema de respuesta GZIP con un encabezado de aceptación con el formato Accept: application/vnd.atlas.YYYY-MM-DD+gzip.
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 clúster que contiene la colección para la que desea devolver los registros de consultas de un archivo en línea.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
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. -
Fecha y hora que especifica el punto de inicio del intervalo de mensajes de registro que se devolverán. Este recurso expresa este valor en segundos transcurridos desde la época UNIX.
El valor mínimo es
1199145600. -
Fecha y hora que especifica el punto final del intervalo de mensajes de registro que se devolverán. Este recurso expresa este valor en segundos transcurridos desde la época UNIX.
El valor mínimo es
1199145600. -
Bandera que indica si se deben descargar registros de consultas en su archivo en línea únicamente o en su archivo en línea y en el clúster.
El valor predeterminado es
false.
Respuestas
-
Vale
Este recurso descarga una entrada de registro comprimida en el directorio de trabajo actual. Puedes especificar su nombre utilizando la opción
--outputo usar el nombre de archivo por defecto con la opción-OJ. El nombre de archivo predeterminado varía según si vas a descargar registros solo para consultas de tu archivo en línea o tanto para tu archivo en línea como para tu clúster. -
Solicitud incorrecta.
-
No autorizado.
-
Forbidden.
-
No se encontró.
-
Error Interno del Servidor.
atlas api onlineArchive downloadQueryLogs --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230201001/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.DownloadGroupClusterOnlineArchiveQueryLogsApiParams{}
sdkResp, httpResp, err := client.OnlineArchiveApi.
DownloadGroupClusterOnlineArchiveQueryLogsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-02-01+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz" \
--output "file_name.gz"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-02-01+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.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": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}