Vista previa pública: por favor, proporciona tus comentarios: Devuelve los índices sugeridos por el Performance Advisor.
El subcomando de la API de Atlas, generado automáticamente a partir de la API de administración de MongoDB Atlas, ofrece cobertura total de la API de administración y actualmente se encuentra en Vista Previa Pública (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentación del endpoint de API proporcionado.
El Asesor de Rendimiento supervisa las consultas que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las consultas. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de solo lectura del proyecto.
Este comando se genera automáticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listclustersuggestedindexes.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api performanceAdvisor listClusterSuggestedIndexes [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Etiqueta legible por humanos que identifica el clúster. |
--ID de grupo | string | true | Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos". |
-h, --ayuda | false | Ayuda para listClusterSuggestedIndexes | |
--namespaces | . | false | Espacios de nombres desde los cuales se recuperan los índices sugeridos. Un espacio de nombres consta de una base de datos y un recurso de colección, escrito como .: |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | 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) |
--identificadores de proceso | mongod | false | Id. de proceso de los que se extraen los índices sugeridos. Un Id. de proceso es una combinación de host y puerto que sirve al proceso de MongoDB. El host debe ser el nombre de host, el FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso de MongoDB (mongod o |
--since | Int | false | Fecha y hora a partir de las cuales la consulta recupera los índices sugeridos. Este parámetro expresa su valor en milisegundos transcurridos desde la [época UNIX](https://en.wikipedia.org/wiki/Unix_time).
|
--until | Int | false | Fecha y hora hasta la cual la consulta recupera los índices sugeridos. Este parámetro expresa su valor en milisegundos transcurridos desde la [época UNIX](https://en.wikipedia.org/wiki/Unix_time).
|
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2024-08-05"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2024-08-05". |
Opciones heredadas
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. |
Ejemplos
atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8