Visualização pública: forneça comentários em: baixa os registros de consulta para a instância do banco de dados federado especificada.
Para usar esse recurso, a chave de API solicitante deve ter as funções "Proprietário do projeto" ou "Acesso de gravação/leitura aos dados do projeto". 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 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Data- Federation/operation/downloadFederatedDatabaseQueryLogs.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api dataFederation downloadFederatedDatabaseQueryLogs [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--endDate | int | false | Registro de data/hora que especifica o ponto de término para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch. |
--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 downloadFederatedDatabaseQueryLogs | |
--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 | Registro de data/hora que especifica o ponto de início para a faixa de mensagens de registro a serem baixadas. O MongoDB Cloud expressa esse registro de data/hora pelo número de segundos decorridos desde a UNIX epoch. |
--tenantName | string | true | Etiqueta legível para humanos que identifica a instância do banco de dados federado para a qual você deseja baixar os registros de query. |
--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
Execute o comando abaixo.
atlas api dataFederation downloadFederatedDatabaseQueryLogs --version 2023-01-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]