Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / / /

atlas API performanceAdvisor listClusterSuggestedIndexes

Visualização pública: forneça comentários em: retorna os índices sugeridos pelo Performance Advisor.

O Performance Advisor monitora as queries que o MongoDB considera lentas e sugere novos índices para melhorar o desempenho das queries. Para usar esse recurso, a chave de API solicitante deve ter a função Somente leitura do projeto.

Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe do comando
atlas api performanceAdvisor listClusterSuggestedIndexes [options]
Nome
Tipo
Obrigatório
Descrição

--clusterName

string

true

Etiqueta legível por humanos que identifica o cluster.

--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 listClusterSuggestedIndexes

--namespaces

.

false

Namespaces dos quais recuperar índices sugeridos. Um namespace consiste em um banco de dados e um recurso de collection escrito como .: <database>.<collection>. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (&) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces.

--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)

--processIds

mongod

false

ProcessIds dos quais recuperar índices sugeridos. Um processId é uma combinação de host e porta que atende ao processo do MongoDB . O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações. Para incluir vários processIds, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (&) entre cada processId.

--since

int

false

Data e hora a partir das quais a query recupera os índices sugeridos. Este parâmetro expressa seu valor no número de milissegundos decorridos desde a [época UNIX](https://en.wikiped.org/wiki/Unix_time).

  • Se você não especificar o parâmetro until, o endpoint retornará os dados que abrangem o valor since e a hora atual.

  • Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.

--until

int

false

Data e hora até que a query recupera os índices sugeridos. Este parâmetro expressa seu valor no número de milissegundos decorridos desde a [UNIX epoch](https://en.wikiped.org/wiki/Unix_time).

  • Se você especificar o parâmetro until, deverá especificar o parâmetro since.

  • Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.

--version

string

false

Versão da API a ser usada ao chamar a chamada da API [opções: "2024-08-05"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2024-08a05".

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.

Execute o comando abaixo.

atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Nesta página