experimental: Baixa registros de consulta para o arquivo on-line especificado.
Para usar esse recurso, a chave de API solicitante deve ter a role Somente leitura de acesso a dados do projeto ou superior. A API não suporta chamadas diretas com o esquema de resposta JSON. Você deve solicitar um esquema de resposta gzip usando um cabeçalho de aceitação do formato: "Aceitar: aplicação/vnd.atlas.YYYY-MM-DD+gzip". Este comando está invocando o endpoint com OperationID: 'downloadOnlineArchiveQueryLogs'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs
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 ponto de término para a faixa de mensagens de registro a serem retornadas |
--envelope | false | sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope | |
--groupId | string | true | string exclusiva de dígitos hexadecimais 24que identifica seu projeto |
-h, --help | false | ajuda para downloadOnlineArchiveQueryLogs | |
--output | string | false | formato de API preferido, pode ser ["gzip"] Este valor padrão é "gzip". |
--output-file | 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 especifica o ponto de partida para o intervalo de mensagens de registro a serem retornadas |
--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. |