Visualização pública: forneça comentários: registra registros de consulta de downloads para o arquivo on-line especificado.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
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".
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-downloadonlinearchivequerylogs.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api onlineArchive downloadOnlineArchiveQueryLogs [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--archiveOnly | false | Sinalizador que indica se o download de logs para queries é feito somente para o arquivo online ou para o arquivo online e o cluster. | |
--clusterName | string | true | 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. |
--endDate | int | false | Data e hora que especifica o end ponto 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](https://en.wikiped.org/wiki/Unix_time). |
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de 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 query. 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. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar 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. |
-h, --help | false | ajuda para downloadOnlineArchiveQueryLogs | |
-o, --output | string | false | formato de API preferido, pode ser ["gzip"] Este valor padrão é "gzip". |
--outputFile | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--startDate | int | 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](https://en.wikiped.org/wiki/Unix_time). |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09