Devuelve los índices que recomienda el Performance Advisor.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
El Performance Advisor supervisa las queries que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las queries. Para utilizar este recurso, la cuenta de servicio o la clave de API que realiza la solicitud debe tener el rol Solo lectura del proyecto.
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-listgroupprocessperformanceadvisorsuggestedindexes.
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 listSuggestedIndexes [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--duration | Int | false | Duración del tiempo durante el cual la query encuentra los índices sugeridos entre los namespaces gestionados en el clúster. Este parámetro expresa su valor en milisegundos.
|
--envelope | envelope | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. 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 | 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 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 listSuggestedIndexes | |
--includeCount | false | Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta. | |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
--nExamples | Int | false | Número máximo de consultas de ejemplo que se benefician del índice sugerido. |
--nIndexes | Int | false | Número que indica los máximos índices a sugerir. |
--namespaces | . | false | Espacios de nombres de los cuales recuperar los índices sugeridos. Un namespace 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". |
--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) |
--número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--processId | mongod | true | Combinación de host y puerto que sirve para el proceso de MongoDB. El host debe ser el nombre del host, FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso MongoDB (mongod o |
--since | Int | false | Fecha y hora a partir de las que la query recupera los índices sugeridos. Este parámetro expresa su valor en el número de milisegundos transcurridos desde la [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).
|
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
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 listSuggestedIndexes --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId [processId]