Baixar registros de query do Online Archive
Baixa logs de query para o arquivo online especificado. Para usar este recurso, a conta de serviço ou chave de API solicitante deve ter a função Somente leitura de acesso a dados do projeto ou superior. A API não oferece suporte a chamadas diretas com o esquema de resposta json. É preciso solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível por humanos que identifica o cluster que contém a collection para a qual você deseja retornar os logs de query de um arquivo online.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Data e hora que especificam o ponto de partida para o intervalo de mensagens de registro a serem retornadas. Esse recurso expressa esse valor no número de segundos decorridos desde a UNIX epoch.
O valor mínimo é
1199145600. -
Data e hora que especifica o end point para a faixa de mensagens de log a ser retornada. Esse recurso expressa esse valor no número de segundos decorridos desde a UNIX epoch.
O valor mínimo é
1199145600. -
Sinalizador que indica se o download de logs para queries é feito somente para o arquivo online ou para o arquivo online e o cluster.
O valor padrão é
false.
Respostas
-
OK
Esse recurso baixa um arquivo de log compactado para seu diretório de trabalho atual. Você pode especificar seu nome utilizando a opção
--outputou utilizar o nome de arquivo padrão utilizando a opção-OJ. O nome do arquivo padrão varia com base no fato de você baixar registros para queries do arquivo online apenas ou de ambos o arquivo online e cluster. -
Solicitação inválida.
-
Não autorizado.
-
Forbidden.
-
Não encontrado.
-
Erro interno do servidor.
atlas api onlineArchive downloadGroupClusterOnlineArchiveQueryLogs --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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.2024-05-30+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.2024-05-30+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"
}