- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Visualização pública: forneça feedback em: retorna os registros de acesso de um cluster identificado pelo nome de host do cluster.
Os registros de acesso contêm uma lista de solicitações de autenticação feitas em seus clusters. Você não pode utilizar esta funcionalidade em clusters de nível de locatário (M0, M2, M5). Para usar esse recurso, a chave de API solicitante deve ter a role de administrador do Project Monitoring ou a role de administrador do Project Database Access.
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/Access- Rastreamento/operation/listAccessLogsByHostname.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api accessTracking listAccessLogsByHostname [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--authResult | false | Sinalizador que indica se a resposta retorna apenas as tentativas de autenticação bem-sucedidas. | |
--end | int | false | Data e hora para parar de recuperar o histórico do banco de dados. Se você especificar o fim, você também deverá especificar o início. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
--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 listAccessLogsByHostname | |
--hostname | string | true | Nome de domínio totalmente qualificado ou endereço IP do host do MongoDB que armazena os arquivos de registro que você deseja baixar. |
--ipAddress | string | false | Um endereço de protocolo de internet que tentou autenticar com o banco de dados. |
--nLogs | int | false | Número máximo de linhas do registro a serem retornadas. |
--output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>. | |
--start | int | false | Data e hora em que o MongoDB Cloud começa a recuperar o histórico do banco de dados. Se você especificar o início, também deverá especificar o fim. Este parâmetro usa o tempo UNIX epoch em milissegundos. |
--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 accessTracking listAccessLogsByHostname --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] --pretty false