atlas api queryShapeInsights getQueryShape Details

--clusterName

string

true

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

-- envelope

envelope

false

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

--groupId

string

true

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

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

-h, --help

false

getQueryShape Details のヘルプ

-o, --output

string

false

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

-- outputFile

string

false

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

--pretty

false

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

--processIds

processId

false

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

--queryShapeHash

$queryStats

true

クエリシェイプの SHA256 ハッシュされたは、$queryStats や $explain または低速クエリ ログなどのMongoDBコマンドによって出力されます。

--since

整数

false

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

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

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

--until

整数

false

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

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

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

--version

string

false

Atlas API エンドポイントを呼び出すときに使用する API バージョン [オプション: "2025-03-12"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2025-03-12" です。