クエリ統計の概要を返す
指定されたクラスターのクエリシェイプ統計の概要の一覧を返します。クエリシェイプ統計は、 MongoDBクエリに関するパフォーマンスに関するインサイトを提供し、ユーザーが問題のあるクエリ パターンと潜在的な最適化を特定するのに役立ちます。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
クラスターを識別する人間が判読できるラベル。
形式は次のパターンと一致する必要があります:
^[a-zA-Z0-9][a-zA-Z0-9-]*$。
クエリ パラメータ
-
クエリシェイプ統計を取得する日時。このパラメータは、UNIXエポックから経過したミリ秒数で値を表します。
- into パラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。
- sinceパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去の24時間のデータを返します。
の最小値は
1199145600000です。 -
クエリシェイプ統計を検索する期限となる日時。このパラメータは、 UNIXエポックから経過したミリ秒数で値を表します。
- into パラメーターを指定する場合は、 sinceパラメーターを指定する必要があります。
- sinceパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去の24時間のデータを返します。
の最小値は
1199145600000です。 -
クエリシェイプ統計を取得する ProcessId。ProcessId は、 MongoDBプロセスを提供するホストとポートの組み合わせです。ホストは、 MongoDBプロセス（
mongodまたはmongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートはMongoDBプロセスがリクエストをリッスンする IANA ポートである必要があります。複数のプロセス ID を含めるには、各プロセス ID の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。10要素以下各 の形式は次のパターンと一致する必要があります:^([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})$。 -
クエリシェイプ統計を検索する名前空間。名前空間は 1 件のデータベースと 1 件のコレクションリソースで構成され、
.:<database>.<collection>と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。10要素以下 -
指定されたMongoDBコマンドに一致するクエリシェイプ統計を取得します 。複数の コマンドを含めるには、各コマンド間でアンパサンド (
&) で区切って、パラメーターを複数回渡します。現在サポートされているパラメーターは、検索、個別、集計です。このパラメーターを省略すると、サポートされているすべてのコマンドの結果が返されます。3要素以下値は、find、distinct、またはaggregateです。 -
返されるクエリ統計サマリーの最大数。
最小値は
1、最大値は100です。デフォルト値は100です。 -
取得するクエリ形状統計データ シリーズ。シリーズは、クエリ実行に関する特定のメトリクスを表します。複数のシリーズを含めるには、各シリーズ間をアンパサンド (
&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。14要素以下値はTOTAL_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_TIME、またはP99_EXECUTION_TIME。 -
$queryStats や $explain などの MongoDB コマンドまたは低速クエリ ログなどのMongoDBコマンドによって出力される、必要なクエリシェイプの SHA256 ハッシュのリスト。複数のシリーズを含めるには、各シリーズ間をアンパサンド (
&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。10要素以下各 の形式は次のパターンと一致する必要があります:^([a-fA-F0-9]{64})$。 -
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
atlas api queryShapeInsights listGroupClusterQueryShapeInsightSummaries --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",
"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"
}