Devuelve una lista de resúmenes de estadísticas de formas de consultas para un determinado clúster.
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.
Las estadísticas de forma de consulta brindan información sobre el rendimiento de las consultas de MongoDB, lo que ayuda a los usuarios a identificar patrones de consulta problemáticos y posibles optimizaciones.
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-listgroupclusterqueryshapeinsightsummaries.
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 queryShapeInsights listQueryShapeSummaries [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--clusterName | string | true | Etiqueta legible por humanos que identifica el clúster. |
--comandos | Y | false | Recupera estadísticas de formas de consultas que coincidan con los comandos de MongoDB especificados. Para incluir múltiples comandos, pasa el parámetro varias veces delimitado por un ampersand (&) entre cada comando. Los parámetros actualmente admitidos son find, distinct y aggregate. Omite este parámetro para retornar resultados de todos los comandos admitidos. |
--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 listQueryShapeSummaries | |
--nResúmenes | Int | false | Número máximo de resúmenes de estadísticas de consulta a devolver. |
--namespaces | . | false | Namespaces desde los cuales recuperar estadísticas de la forma del query. Un namespace consiste en una base de datos y un recurso de colección escritos 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) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--processIds | mongod | false | ProcessIds de los que se van a recuperar estadísticas de forma del query. Un processId es una combinación de host y puerto que sirve para el proceso MongoDB. El host debe ser el nombre, el FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso MongoDB (mongod o |
--queryShapeHashes | Y | false | Una lista de hashes SHA256 de las formas de consulta deseadas, generada por comandos de MongoDB como $queryStats, $explain o los registros de consultas lentas. Para incluir múltiples series, pasa el parámetro varias veces delimitado con un signo “&” (&) entre cada serie. Omite este parámetro para obtener resultados de todas las series disponibles. |
--series | Y | false | Consultar la serie de datos de estadísticas de forma del query para recuperar. Una serie representa una métrica específica sobre la ejecución de la query. Para incluir varias series, pasa el parámetro varias veces delimitado con un símbolo de ampersand (&) entre cada serie. Omitir este parámetro para devolver los resultados de todas las series disponibles. |
--since | Int | false | Fecha y hora a partir de la cual se recuperarán las estadísticas de forma del query. Este parámetro expresa su valor en el número de milisegundos transcurridos desde la [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).
|
--until | Int | false | Fecha y hora hasta la que se recuperan las estadísticas de la forma de la consulta. 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 la API que se utilizará al llamar a la llamada de API [opciones: "2025-03-12"], 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 "2025-03-12". |
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 queryShapeInsights listQueryShapeSummaries --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8