Descarga los registros de query para el fichero en línea especificado. Para usar este recurso, la Cuenta de servicio o clave de API que lo solicita debe tener el rol de "Acceso de solo lectura a los datos del proyecto" o superior. La API no admite llamadas directas con el esquema de respuesta JSON. Debe solicitar un esquema de respuesta gzip utilizando un encabezado de aceptación del formato: "Accept: aplicación/gzip".
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 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.
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 query de un fichero en línea.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Fecha y hora que especifica el punto de inicio para el rango de mensajes de registro a devolver. Este recurso expresa este valor en el número de segundos que han transcurrido desde la Unix epoch.
El valor mínimo es
1199145600. -
Fecha y hora que especifica el punto final del rango de mensajes de registro a devolver. Este recurso expresa este valor en el número de segundos transcurridos desde la época UNIX.
El valor mínimo es
1199145600. -
Bandera que indica si se deben descargar registros solo para queries realizadas en el fichero en linea o tanto en el fichero en linea como en el clúster.
El valor por defecto 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.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/onlineArchives/queryLogs.gz' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"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"
}