Menu Docs
Página inicial do Docs
/ /

atlas API performanceAdvisor listSuggestedIndexes

Retorna os índices sugeridos pelo Performance Advisor.

O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. 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.

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

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/ operation-listgroupprocessperformanceadvisorsuggestedindexes.

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

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

--duration

int

false

Duração do tempo expresso durante o qual a consulta encontra índices sugeridos entre os namespaces gerenciados no cluster. Este parâmetro expressa seu valor em milissegundos.

  • Se você não especificar o parâmetro since, o ponto de extremidade retornará os dados cobrindo a duração antes do tempo atual.

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

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

--includeCount

false

Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.

--itemsPerPage

int

false

Número de itens que a resposta retorna por página.

--nExamples

int

false

Número máximo de exemplos de consultas que se beneficiam do índice sugerido.

--nIndexes

int

false

Número que indica os índices máximos a sugerir.

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

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

--pageNum

int

false

Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

--pretty

false

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

--processId

mongod

true

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.

--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 duration , o ponto de extremidade retornará os dados que abrangem o valor since e a hora atual.

  • Se você não especificar os parâmetros duration e since, 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: "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".

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.

atlas api performanceAdvisor listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId]

Voltar

listSlowQueryNamespaces

Nesta página