Devuelve los índices cuya eliminación sugiere el Performance Advisor.
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.
El Performance Advisor recomienda eliminar índices ocultos, no utilizados ni redundantes para mejorar el rendimiento de las grabaciones y aumentar el espacio de almacenamiento.
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-listgroupclusterperformanceadvisordropindexsuggestions.
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 performanceAdvisor listDropIndexSuggestions [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Etiqueta legible por humanos que identifica el clúster. |
--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 listDropIndexSuggestions | |
-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) |
--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-08-05"]. 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-08-05". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api performanceAdvisor listDropIndexSuggestions --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8