atlas API performanceAdvisor listClusterSuggestedIndexes

--clusterName

string

true

Etiqueta legível por humanos que identifica o cluster.

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

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

--processIds

processId

false

IDs de processo a partir dos quais recuperar os índices sugeridos. Um processId é uma combinação de hospedar e porta que serve ao processo do MongoDB. O hospedar deve ser o nome de hospedar, FQDN, endereço IPv4 ou endereço IPv6 do hospedar 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 [UNIX epoch](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 os pontos de extremidade da API do Atlas [opções: "2024-08-05"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Esse valor padroniza para "2024-08-05".