Docs Menu
Docs Home
/ /

API de Atlas queryShapeInsights getQueryShapeDetails

Devuelve el resumen de metadatos y estadísticas para un hash de forma de consulta 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.

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

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis del comando
atlas api queryShapeInsights getQueryShapeDetails [options]
Nombre
Tipo
Requerido
Descripción

--clusterName

string

true

Etiqueta legible por humanos que identifica el clúster.

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

-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 de los cuales se recuperan las estadísticas de forma de consulta. 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 mongosEl puerto debe ser el puerto IANA en el que el proceso MongoDB recibe solicitudes. Para incluir varios identificadores de proceso, pase el parámetro varias veces, delimitado por un símbolo "&" (&) entre cada identificador de proceso.

--queryShapeHash

string

true

Un hash SHA256 de una forma del query, generado por comandos de MongoDB como $queryStats y $explain o logs de queries lentas.

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

  • Si no especifica el parámetro hasta, el punto final devuelve datos que abarcan desde el valor desde y la hora 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 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).

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

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.

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

Volver

obtenerClusterQueryShape

En esta página