Docs Menu
Docs Home
/ /

atlas api queryShapeInsights listQueryShapeSummaries

Devuelve una lista de resúmenes de estadísticas de formas de consultas para un determinado clúster.

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.

Las estadísticas de formas del query ofrecen información sobre el rendimiento de los queries de MongoDB, ayudando a los usuarios a identificar patrones de queries 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 del comando
atlas api queryShapeInsights listQueryShapeSummaries [options]
Nombre
Tipo
Requerido
Descripción

--clusterName

string

true

Etiqueta legible por humanos que identifica el clúster.

--comandos

&

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 señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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

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 listQueryShapeSummaries

--nSummaries

Int

false

Número máximo de resúmenes estadísticos de consultas que se deben 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 .: <database>.<collection>. Para incluir varios espacios de nombres, pase el parámetro varias veces delimitado con un ampersand (&) entre cada espacio de nombres. Omita este parámetro para devolver resultados de todos los espacios de nombres.

-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)

--bastante

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 mongos). El puerto debe ser el puerto IANA en el que el proceso de MongoDB escucha solicitudes. Para incluir varios processIds, pasa el parámetro varias veces separado por un ampersand (&) entre cada processId.

--queryShapeHashes

&

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

&

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).

  • Si no se especifica el parámetro hasta, el endpoint devuelve datos que cubren desde el valor desde hasta el momento actual.

  • Si no especificas los parámetros since o until, el endpoint devuelve datos de las 24 horas anteriores.

--until

Int

false

Fecha y hora hasta la cual recuperar las estadísticas de forma del query. Este parámetro expresa su valor en el número de milisegundos que han transcurrido desde la [Unix epoch](https://en.wikipedia.org/wiki/Unix_time).

  • Si especifica el parámetro hasta, debe especificar el parámetro desde.

  • Si no especificas los parámetros since o until, el endpoint devuelve datos de las 24 horas anteriores.

--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".

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.

atlas api queryShapeInsights listQueryShapeSummaries --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

Volver

listClusterQueryShapes

En esta página