atlas api atlasSearch getClusterSearchIndex

--clusterName

string

true

Nombre del clúster que contiene la colección con uno o más índices de Atlas Search.

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

--indexId

string

true

Cadena única de dígitos hexadecimales 24 que identifica el índice de búsqueda de aplicaciones (https://dochub.mongodb.org/core/index-definitions-fts).Utilice el punto final [Obtener todos los índices de búsqueda de aplicaciones para una colección](https://mongodb.com/es/docs/atlas/reference/api/fts-indexes-get-all/) para encontrar los ID de todos los índices de búsqueda de aplicaciones.

-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 debe usar al llamar a los endpoints de la API de Atlas [opciones: "2024-05-30"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2024-05-30".