Retorne os detalhes do índice de pesquisa para um cluster.
Visualização pública: o subcomando atlas api, 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 feedback em https://feedback.mongodb.com/ fóruns/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.
Para usar este comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Leitura/Gravação de Acesso a Dados do projeto.
Sintaxe
atlas clusters search indexes describe <indexId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
indexId | string | true | ID do índice. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
-h, --help | false | ajuda para descrever | |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
ID NAME DATABASE COLLECTION TYPE <IndexID> <Name> <Database> <CollectionName> <Type>
Exemplos
# Return the JSON-formatted details for the search index with the ID 5f1f40842f2ac35f49190c20 for the cluster named myCluster: atlas clusters search indexes describe 5f1f40842f2ac35f49190c20 --clusterName myCluster --output json