Devuelve todos los 铆ndices de b煤squeda de Atlas en la colecci贸n especificada.
El subcomando del atlas api se genera autom谩ticamente a partir de la API de administraci贸n de MongoDB Atlas y ofrece una cobertura total de la API de administraci贸n. Las capacidades de la API de administraci贸n tienen su propio ciclo de vida de lanzamiento, que puedes consultar a trav茅s del enlace a la documentaci贸n del endpoint de la API proporcionada.
Los 铆ndices de Atlas Search contienen los campos indexados y los analizadores usados para crear los 铆ndices. Para utilizar este recurso, la cuenta de servicio o clave de API que realiza la solicitud debe tener el rol de Lectura/Escritura de Acceso a Datos de Proyectos.
Este comando se genera autom谩ticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterftsindex.
Para obtener m谩s informaci贸n y ejemplos, consulta la documentaci贸n de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api atlasSearch listClusterFtsIndex [options]
opciones
Nombre | Tipo | Requerido | Descripci贸n |
|---|---|---|---|
--clusterName | string | true | Nombre del cl煤ster que contiene la colecci贸n con uno o m谩s 铆ndices de Atlas Search. |
--collectionName | string | true | Nombre de la colecci贸n que contiene uno o m谩s 铆ndices de b煤squeda de Atlas. |
--databaseName | string | true | Etiqueta legible por humanos que identifica la base de datos que contiene la colecci贸n con uno o m谩s 铆ndices de b煤squeda de Atlas. |
--envelope | envelope | false | Indicador que se帽ala si la Aplicaci贸n envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al c贸digo de estado. Para remediarlo, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicaci贸n a帽ade el par谩metro de estado al cuerpo de la respuesta. |
--groupId | string | true | string hexadecimal 煤nica de 24d铆gitos que identifica tu proyecto. Utiliza el punto final [/groups](#tag/Projects/operation/listProjects) para recuperar todos los proyectos a los que el usuario autenticado tiene acceso. NOTA: Grupos y proyectos son t茅rminos sin贸nimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el t茅rmino grupos. |
-h, --help | false | ayuda para listClusterFtsIndex | |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON". |
--outputFile | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--bastante | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versi贸n | string | false | versi贸n de la API que se utilizar谩 al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versi贸n m谩s reciente o el valor de configuraci贸n api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripci贸n |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizar谩 en tu archivo de configuraci贸n. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api atlasSearch listClusterFtsIndex --version 2023-01-01 --clusterName [clusterName] --collectionName [collectionName] --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8