Atlas API queryShapeInsights getGroupClusterQueryShapeInsightsumarys

string

true

クラスターを識別する人間が判読できるラベル。

&

false

指定されたMongoDBコマンドに一致するクエリシェイプ統計を取得します 。複数の コマンドを含めるには、各コマンド間でアンパサンド ( &) で区切って、パラメーターを複数回渡します。現在サポートされているパラメーターは、検索、個別、集計です。このパラメーターを省略すると、サポートされているすべてのコマンドの結果が返されます。

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

false

getGroupClusterQueryShapeInsightsumary のヘルプ

整数

false

返されるクエリ統計サマリーの最大数。

.

false

クエリシェイプ統計を検索する名前空間。名前空間は 1 件のデータベースと 1 件のコレクションリソースで構成され、.: <database>.<collection> と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

mongod

false

クエリシェイプ統計を取得する ProcessId。ProcessId は、 MongoDBプロセスを提供するホストとポートの組み合わせです。ホストはMongoDBプロセス（mongodまたは mongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートはMongoDBプロセスがリクエストをリッスンする IANA ポートである必要があります。複数のプロセス ID を含めるには、各プロセス ID の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。

&

false

$queryStats や $explain などの MongoDB コマンドまたは低速クエリ ログなどのMongoDBコマンドによって出力される、必要なクエリシェイプの SHA256 ハッシュのリスト。複数のシリーズを含めるには、各シリーズ間をアンパサンド ( &) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。

&

false

取得するクエリ形状統計データ シリーズ。シリーズは、クエリ実行に関する特定のメトリクスを表します。複数のシリーズを含めるには、各シリーズ間をアンパサンド ( &) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、使用可能なすべての系列の結果が返されます。

整数

false

クエリシェイプ統計を取得する日時。このパラメータは、[UNIX エポック]（ https://en.wiki.org/wiki/Unix_time ）から経過したミリ秒数で値を表します。

• into パラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。

• sinceパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去の24時間のデータを返します。

整数

false

クエリシェイプ統計を取得する日時。このパラメーターは、[UNIX エポック]（ https://en.wiki.org/wiki/Unix_time ）から経過したミリ秒数で値を表します。

• into パラメーターを指定する場合は、 sinceパラメーターを指定する必要があります。

• sinceパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去の24時間のデータを返します。

string

false

API 呼び出し [options: "2025-03-12"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2025-03-12"