API do atlas atlasSearch getAtlasSearchIndexByName

O suporte do Atlas CLI para executar comandos com o está em pré-visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: Retorna um índice do Atlas Search no projeto especificado.

Você identifica este índice utilizando seu banco de dados, coleção e nome. 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 está invocando o endpoint com OperationID: 'getAtlasSearchIndexByName'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName

Sintaxe

Sintaxe do comando

atlas api atlasSearch getAtlasSearchIndexByName [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
--collectionName	string	true	nome da coleção que contém um ou mais índices do Atlas Search
--databaseName	string	true	rótulo que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
--groupId	string	true	string exclusiva de dígitos hexadecimais 24que identifica seu projeto
-h, --help		false	ajuda para getAtlasSearchIndexByName
--indexName	string	true	nome do índice do Atlas Search para retornar
--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)
--pretty		false	sinalizador que indica se o corpo da resposta deve estar no formato de impressão bonita
--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.

Voltar

getAtlasSearchIndex

getAtlasSearchIndexDeprecated