Describe un índice de búsqueda para la implementación especificada.
Sintaxis
atlas deployments search indexes describe [indexId] [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
indexId | string | false | ID del índice. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--deploymentName | string | false | Nombre de la implementación. |
-h, --help | false | ayuda para describir | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--password | string | false | Contraseña para el usuario. |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el archivo de configuración o la variable de entorno. |
--type | string | false | Tipo de implementación. Los valores válidos son ATLAS o LOCAL. |
--username | string | false | Nombre de usuario para autenticarse en MongoDB. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
ID NAME DATABASE COLLECTION STATUS TYPE <IndexID> <Name> <Database> <CollectionName> <Status> <Type>