Retorna uma lista de resumos de estatísticas de forma de query para um determinado cluster. As estatísticas de forma de query fornecem insights de desempenho sobre as queries do MongoDB , ajudam os usuários a identificar padrões de query problemáticos e possíveis otimizações.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Etiqueta legível por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
parâmetros de query
-
Data e hora a partir das quais recuperar as estatísticas da forma de query . Este parâmetro expressa seu valor no número de milissegundos decorridos desde a UNIX epoch.
- Se você não especificar o parâmetro until, o endpoint retornará os dados que abrangem o valor since e a hora atual.
- Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.
O valor mínimo é
1199145600000. -
Data e hora até as quais recuperar as estatísticas de forma de query. Esse parâmetro expressa seu valor no número de milissegundos decorridos desde a Era UNIX.
- Se você especificar o parâmetro until, deverá especificar o parâmetro since.
- Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.
O valor mínimo é
1199145600000. -
ProcessIds dos quais recuperar estatísticas da forma de query . Um processId é uma combinação de host e porta que atende ao processo do MongoDB . O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço IPv6 do host que executa o processo do MongoDB (
mongodoumongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações. Para incluir vários processIds, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (&) entre cada processId.Não mais do que
10elementos. O formato de cada um deve corresponder ao seguinte padrão:^([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})$. -
Namespaces dos quais recuperar estatísticas de forma de query . Um namespace consiste em um banco de dados e um recurso de collection escrito como
.:<database>.<collection>. Para incluir vários namespaces, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (&) entre cada namespace. Omita este parâmetro para retornar resultados de todos os namespaces.Não mais do que
10elementos. -
Recupere estatísticas de forma de query correspondentes a comandos MongoDB especificados. Para incluir vários comandos, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (
&) entre cada comando. Os parâmetros atualmente suportados são localizar, distinto e agregado. Omitir este parâmetro para retornar resultados para todos os comandos suportados.Não mais do que
3elementos. Os valores sãofind,distinctouaggregate. -
Número máximo de resumos de estatísticas de query a serem retornados.
O valor mínimo é
1, o valor máximo é100. O valor padrão é100. -
Série de dados de estatísticas de forma de query a ser recuperada. Uma série representa uma métrica específica sobre a execução da query. Para incluir várias séries, passe o parâmetro várias vezes, delimitado por um sinal tipográfico (
&) entre cada série. Omitir este parâmetro para retornar resultados para todas as séries disponíveis.Não mais do que
14elementos. Os valores sãoTOTAL_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_TIMEouP99_EXECUTION_TIME. -
Uma lista de hashes SHA256 das formas de query desejadas, saída de comandos do MongoDB como $queryStats e $explain ou slow query logs. Para incluir várias séries, passe o parâmetro várias vezes, delimitado por um sinal tipográfico (
&) entre cada série. Omitir este parâmetro para retornar resultados para todas as séries disponíveis.Não mais do que
10elementos. O formato de cada um deve corresponder ao seguinte padrão:^([a-fA-F0-9]{64})$. -
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
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"
}