Detalles de la forma de la consulta de retorno

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/queryShapeInsights/{queryShapeHash}/detalles

Devuelve el resumen de metadatos y estadísticas para un hash de forma de consulta determinado.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups 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".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

  • consultaShapeHash string Requerido

    Un hash SHA256 de una forma de consulta, generado por comandos MongoDB como $queryStats y $explain o registros de consultas lentas.

    El formato debe coincidir con el siguiente patrón: ^([a-fA-F0-9]{64})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. 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 encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita
  • desde integer(int64)

    Fecha y hora de recuperación de las estadísticas de forma de la consulta. Este parámetro expresa su valor en milisegundos transcurridos desde la época UNIX.

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

    El valor mínimo es 1199145600000.

  • hasta integer(int64)

    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 de UNIX.

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

    El valor mínimo es 1199145600000.

  • identificadores de proceso array[string]

    ID de proceso de los que se obtienen las estadísticas de forma de consulta. Un 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 mongos). El puerto debe ser el puerto IANA en el que el proceso de MongoDB recibe las solicitudes. Para incluir varios processIds, pase el parámetro varias veces, delimitado por un símbolo & (&) entre cada processId.

    No más de 10 elementos. El formato de cada uno debe coincidir con el siguiente patrón: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

Respuestas

  • 200 application/vnd.atlas.2025-03-12+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • visto por primera vez Objeto

      Metadatos sobre cuándo se vio una forma de consulta.

      Ocultar atributos de firstSeen Mostrar atributos firstSeen Objeto
      • nombreDeLaAplicación string

        El nombre de la aplicación de la que proviene esta forma de consulta. Se puede configurar mediante la cadena de conexión de MongoDB. El nombre de la aplicación se establece como desconocido para las consultas internas de MongoDB.

      • nombre del conductor string

        El nombre del controlador de MongoDB desde el que se ejecutó esta forma de consulta. El nombre del controlador se establece como desconocido para las consultas internas de MongoDB.

      • Versión del controlador string

        La versión del controlador MongoDB desde la que se ejecutó esta forma de consulta. La versión del controlador es desconocida para las consultas internas de MongoDB.

      • fecha y hora integer(int64)

        Milisegundos de época Unix del tiempo.

    • lastSeen Objeto

      Metadatos sobre cuándo se vio una forma de consulta.

      Ocultar atributos de lastSeen Mostrar atributos de lastSeen Objeto
      • nombreDeLaAplicación string

        El nombre de la aplicación de la que proviene esta forma de consulta. Se puede configurar mediante la cadena de conexión de MongoDB. El nombre de la aplicación se establece como desconocido para las consultas internas de MongoDB.

      • nombre del conductor string

        El nombre del controlador de MongoDB desde el que se ejecutó esta forma de consulta. El nombre del controlador se establece como desconocido para las consultas internas de MongoDB.

      • Versión del controlador string

        La versión del controlador MongoDB desde la que se ejecutó esta forma de consulta. La versión del controlador es desconocida para las consultas internas de MongoDB.

      • fecha y hora integer(int64)

        Milisegundos de época Unix del tiempo.

    • queryStats Objeto

      Un resumen de las estadísticas de ejecución para una forma de consulta determinada.

      Hide queryStats attributes Mostrar atributos de queryStats Objeto
      • promedioTrabajandoMillis número(doble)

        Tiempo total promedio en milisegundos dedicado a ejecutar consultas con la forma de consulta especificada. Si la consulta generó getMore comandos, esta métrica incluye el tiempo dedicado a procesar las getMore solicitudes. Esta métrica no incluye el tiempo de espera del cliente.

      • bytesLeídos número(doble)

        La cantidad de bytes leídos por la forma de consulta dada desde el disco a la memoria caché.

      • Comando string

        El comando MongoDB emitido para esta forma de consulta.

        Los valores son find, distinct o aggregate.

      • documentos examinados número(doble)

        Número total de documentos examinados por consultas con la forma de consulta dada.

      • docsExaminedRatio número(doble)

        Proporción de documentos examinados respecto a documentos devueltos por consultas con la forma del query dada.

      • documentos devueltos número(doble)

        Número total de documentos devueltos por queries con la forma del query dada.

      • ejecutivoCount número(doble)

        Número total de veces que se han ejecutado queries con la forma del query dada.

      • llavesExaminadas número(doble)

        Número total de claves de índice dentro y fuera de los límites examinadas por queries con la forma del query dada.

      • clavesExaminadasRatio número(doble)

        Relación de claves de índice dentro y fuera de los límites examinadas con respecto a los índices que contienen documentos devueltos por consultas con la forma de consulta dada.

      • lastExecMicros número(doble)

        Tiempo de ejecución en microsegundos para la consulta más reciente con la forma de consulta dada.

      • namespace string

        Etiqueta legible que identifica el espacio de nombres en el host especificado. El recurso expresa este valor de parámetro como <database>.<collection>.

      • p50ExecMicros número(doble)

        El valor del percentil 50del tiempo de ejecución en microsegundos.

      • p90ExecMicros número(doble)

        El valor del percentil 90del tiempo de ejecución en microsegundos.

      • p99ExecMicros número(doble)

        El valor del percentil 99del tiempo de ejecución en microsegundos.

      • forma de consulta string

        Una forma de consulta es un conjunto de especificaciones que agrupan consultas similares. Estas especificaciones pueden incluir filtros, ordenaciones, proyecciones, etapas de la canalización de agregación, un espacio de nombres, etc. Las consultas con especificaciones similares comparten la misma forma de consulta.

      • consultaShapeHash string

        Una cadena hexadecimal que representa el hash de una forma de consulta de MongoDB.

      • Consulta del sistema booleano

        Indica si esta forma de consulta representa una consulta iniciada por el sistema.

      • Tiempo total de respuesta en micros número(doble)

        Tiempo en microsegundos transcurrido desde el comienzo del procesamiento de la consulta hasta la primera respuesta del servidor.

      • totalTrabajandoMillis número(doble)

        Tiempo total en milisegundos dedicado a ejecutar consultas con la forma de consulta especificada. Si la consulta generó getMore comandos, esta métrica incluye el tiempo dedicado a procesar las getMore solicitudes. Esta métrica no incluye el tiempo de espera del cliente.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 429 aplicación/json

    Demasiadas solicitudes.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/queryShapeInsights/{queryShapeHash}/detalles
atlas api queryShapeInsights getQueryShapeDetails --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupClusterQueryShapeInsightDetailsApiParams{}
	sdkResp, httpResp, err := client.QueryShapeInsightsApi.
		GetGroupClusterQueryShapeInsightDetailsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/queryShapeInsights/{queryShapeHash}/details?pretty=true"
Ejemplos de respuestas (200)
{
  "firstSeen": {
    "applicationName": "string",
    "driverName": "string",
    "driverVersion": "string",
    "timestamp": 42
  },
  "lastSeen": {
    "applicationName": "string",
    "driverName": "string",
    "driverVersion": "string",
    "timestamp": 42
  },
  "queryStats": {
    "avgWorkingMillis": 42.0,
    "bytesRead": 42.0,
    "command": "find",
    "docsExamined": 42.0,
    "docsExaminedRatio": 42.0,
    "docsReturned": 42.0,
    "execCount": 42.0,
    "keysExamined": 42.0,
    "keysExaminedRatio": 42.0,
    "lastExecMicros": 42.0,
    "namespace": "string",
    "p50ExecMicros": 42.0,
    "p90ExecMicros": 42.0,
    "p99ExecMicros": 42.0,
    "queryShape": "string",
    "queryShapeHash": "string",
    "systemQuery": true,
    "totalTimeToResponseMicros": 42.0,
    "totalWorkingMillis": 42.0
  }
}
Ejemplos de respuestas (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (429)
{
  "error": 429,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Too Many Requests",
  "errorCode": "RATE_LIMITED"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}