Devuelve una lista de resúmenes de estadísticas de forma de consulta para un clúster determinado.
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 punto final 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, consulte la documentación de la API referenciada 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 | Recuperar estadísticas de forma de consulta que coincidan con los comandos MongoDB especificados. Para incluir varios comandos, pase el parámetro varias veces, delimitado por un símbolo & entre cada comando. Los parámetros admitidos actualmente son find, distinct y added. Omita este parámetro para obtener resultados de todos los comandos admitidos. |
--sobre | envolvente | 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. |
--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 listQueryShapeSummaries | |
--nResúmenes | Int | false | Número máximo de resúmenes de estadísticas de consulta a devolver. |
--namespaces | . | false | Espacios de nombres desde los cuales se recuperan las estadísticas de forma de consulta. 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) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint. | |
--identificadores de proceso | mongod | false | Id. de proceso (processIds) para recuperar las estadísticas de forma de consulta. Un Id. de proceso (processId) 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 |
--queryShapeHashes | Y | false | Una lista de hashes SHA256 de las formas de consulta deseadas, generada por comandos de MongoDB como $queryStats y $explain o registros de consultas lentas. Para incluir varias series, pase el parámetro varias veces, delimitado por un símbolo & entre cada serie. Omita este parámetro para obtener resultados de todas las series disponibles. |
--serie | Y | false | Serie de datos de estadísticas de forma de consulta que se recuperará. Una serie representa una métrica específica sobre la ejecución de la consulta. Para incluir varias series, pase el parámetro varias veces, delimitado por un símbolo & entre cada serie. Omita este parámetro para obtener resultados de todas las series disponibles. |
--since | Int | false | Fecha y hora de recuperación de 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).
|
--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 API a utilizar al llamar a la llamada de API [opciones: "2025-03-12"], 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 "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