Retorna um índice do Atlas Search que você identificou com ID exclusivo.
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 índice do Atlas Search contém os campos indexados e os analisadores utilizados para criar o índice. Para usar este recurso, a chave de API solicitante deve ter a role de leitura e gravação do projeto de acesso a dados.
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-getgroupclustersearchindex.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api atlasSearch getClusterSearchIndex [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster que contém a coleção com um ou mais índices do Atlas Search. |
--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 getClusterSearchIndex | |
--indexId | string | true | String exclusiva de dígitos hexadecimais que 24identifica o [índice]( https://dochub.mongodb.org/core/index-definitions-fts). Use o endpoint [Obter todos os índices de pesquisa de aplicativos para uma API de coleção](https://mongodb.com/pt-br/docs/atlas/reference/api/fts-indexes-get-all/) para encontrar os IDs de todos Índices do Application Search. |
-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. | |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2024-05-30"], 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-05a30". |
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 atlasSearch getClusterSearchIndex --version 2024-05-30 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --indexId [indexId]