Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas API queryShapeInsights getGroupClusterQueryShapeInsight詳細

パブリック プレビュー:フィードバックを提供してください : 指定されたクエリシェイプハッシュのメタデータと統計の概要を返します。

MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なカバレッジを提供し、現在はパブリック プレビュー段階です( フィードバックでフィードバックを提供してください) 930808Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-v2/ 操作/operation-getgroupclusterqueryshapeinsight Details

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails [options]
名前
タイプ
必須
説明

--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

getGroupClusterQueryShapeInsight Details のヘルプ

-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または mongos)を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートはMongoDBプロセスがリクエストをリッスンする IANA ポートである必要があります。複数のプロセス ID を含めるには、各プロセス ID の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。

--queryShapeHash

string

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

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 getGroupClusterQueryShapeInsightDetails --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --queryShapeHash [queryShapeHash]

戻る

queryShapeInsights

項目一覧