Devuelve una lista de resúmenes de estadísticas de forma de consulta para un clúster determinado. Estas estadísticas proporcionan 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.
Parámetros de ruta
-
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})$. -
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-]*$.
Parámetros de consulta
-
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. -
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. -
ID de proceso de los que se obtienen las estadísticas de forma de consulta. Un
processIdes 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 (mongodomongos). El puerto debe ser el puerto IANA en el que el proceso de MongoDB recibe las solicitudes. Para incluir variosprocessId, pase el parámetro varias veces, delimitado por un símbolo & (&) entre cadaprocessId.No más de
10elementos. 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})$. -
Espacios de nombres de los que se obtienen 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
.:<database>.<collection>. Para incluir varios espacios de nombres, pase el parámetro varias veces, delimitado por un símbolo & (&) entre cada espacio de nombres. Omita este parámetro para obtener resultados para todos los espacios de nombres.No más de
10elementos. -
Recuperar estadísticas de forma de consulta que coincidan con los comandos de 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.No más de
3elementos. Los valores sonfind,distinctoaggregate. -
Número máximo de resúmenes de estadísticas de consulta a devolver.
El valor mínimo es
1, el valor máximo es100. El valor predeterminado es100. -
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.No más de
14elementos. Los valores sonTOTAL_EXECUTION_TIME,AVG_EXECUTION_TIME,EXECUTION_COUNT,KEYS_EXAMINED,DOCS_EXAMINED,DOCS_RETURNED,TOTAL_TIME_TO_RESPONSE,BYTES_READ,KEYS_EXAMINED_RETURNED,DOCS_EXAMINED_RETURNED,LAST_EXECUTION_TIME,P50_EXECUTION_TIME,P90_EXECUTION_TIMEoP99_EXECUTION_TIME. -
Una lista de hashes SHA256 de las formas de consulta deseadas, generada por comandos de MongoDB como
$queryStatsy $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.No más de
10elementos. El formato de cada uno debe coincidir con el siguiente patrón:^([a-fA-F0-9]{64})$. -
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. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
atlas api queryShapeInsights listQueryShapeSummaries --helpimport (
"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.ListGroupClusterQueryShapeInsightSummariesApiParams{}
sdkResp, httpResp, err := client.QueryShapeInsightsApi.
ListGroupClusterQueryShapeInsightSummariesWithParams(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/summaries?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/summaries?pretty=true"{
"summaries": [
{
"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
}
]
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}