Docs Menu
Docs Home
/ /

Los índices de búsqueda de implementaciones de atlas describen

Describe un índice de búsqueda para la implementación especificada.

Sintaxis del comando
atlas deployments search indexes describe [indexId] [options]
Nombre
Tipo
Requerido
Descripción

indexId

string

false

ID del índice.

Nombre
Tipo
Requerido
Descripción

--deploymentName

string

false

Nombre de la implementación.

-h, --ayuda

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

Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del 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.

Nombre
Tipo
Requerido
Descripción

-P, --profile

string

false

Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.

ID NAME DATABASE COLLECTION STATUS TYPE
<IndexID> <Name> <Database> <CollectionName> <Status> <Type>

Next

Atlas CLI

En esta página