Visualização pública: forneça comentários: retorna os registros de acesso de um cluster identificado pelo nome do cluster.
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.
Os logs de acesso contêm uma lista de solicitações de autenticação feitas em seu cluster. Você não pode usar este recurso em clusters de nível de locatário (M0, M2, M5). Para usar este recurso, a conta de serviço de solicitação ou a chave de API deve ter a função de administrador de monitoramento de projeto ou a função de administrador de acesso ao banco de dados do projeto.
Este comando é gerado automaticamente e 1 corresponde:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listaccesslogsbyclustername .
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api accessTracking listAccessLogsByClusterName [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. | |
--clusterName | string | true | Etiqueta legível por humanos que identifica o cluster. |
--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 listAccessLogsByClusterName | |
--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. |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--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
atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8