指定されたクラスターのクエリシェイプ統計の概要の一覧を返します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
クエリシェイプ統計は、 MongoDBクエリに関するパフォーマンスに関するインサイトを提供し、ユーザーが問題のあるクエリ パターンと潜在的な最適化を特定するのに役立ちます。
1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 /操作/ operation-listgroupclusterqueryshapeinsightsumarys を参照してください。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api queryShapeInsights listQueryShapeSummaries [options] 
オプション
| 名前 | タイプ | 必須 | 説明 | 
|---|---|---|---|
| --clusterName | string | true | クラスターを識別する人間が判読できるラベル。 | 
| --commands | & | false | 指定されたMongoDBコマンドに一致するクエリシェイプ統計を取得します 。複数の コマンドを含めるには、各コマンド間でアンパサンド ( &) で区切って、パラメーターを複数回渡します。現在サポートされているパラメーターは、検索、個別、集計です。このパラメーターを省略すると、サポートされているすべてのコマンドの結果が返されます。 | 
| -- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 | 
| --groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 | 
| -h, --help | false | listQueryShapesumary のヘルプ | |
| --n Summary | 整数 | false | 返されるクエリ統計サマリーの最大数。 | 
| --namespaces | . | false | クエリシェイプ統計を検索する名前空間。名前空間は 1 件のデータベースと 1 件のコレクションリソースで構成され、.:  | 
| -o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 | 
| -- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 | 
| --pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
| --processIds | mongod | false | クエリシェイプ統計を取得する ProcessId。ProcessId は、 MongoDBプロセスを提供するホストとポートの組み合わせです。ホストはMongoDBプロセス(mongodまたは  | 
| --queryShapeHasheds | & | false | $queryStats や $explain などの MongoDB コマンドまたは低速クエリ ログなどのMongoDBコマンドによって出力される、必要なクエリシェイプの SHA256 ハッシュのリスト。複数のシリーズを含めるには、各シリーズ間をアンパサンド ( &) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。 | 
| --series | & | false | 取得するクエリ形状統計データ シリーズ。シリーズは、クエリ実行に関する特定のメトリクスを表します。複数のシリーズを含めるには、各シリーズ間をアンパサンド ( &) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。 | 
| --since | 整数 | false | クエリシェイプ統計を取得する日時。このパラメータは、[UNIX エポック]( https://en.wiki.org/wiki/Unix_time )から経過したミリ秒数で値を表します。 
 | 
| --until | 整数 | false | クエリシェイプ統計を取得する日時。このパラメーターは、[UNIX エポック]( https://en.wiki.org/wiki/Unix_time )から経過したミリ秒数で値を表します。 
 | 
| --version | string | false | API 呼び出し [options: "2025-03-12"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2025-03-12" | 
継承されたオプション
| 名前 | タイプ | 必須 | 説明 | 
|---|---|---|---|
| -P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 | 
例
atlas api queryShapeInsights listQueryShapeSummaries --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8