Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

Atlas API performanceAdvisor listClusterSugestedIndexes

パブリック プレビュー: でフィードバックを提供してください: Performance Advisor が提案するインデックスを返します。

Performance Advisor は MongoDB が遅いと判断したクエリをモニターし、クエリ パフォーマンスを改善するための新しいインデックスを提案します。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Performance- に対応しますAdvisor/操作/listClusterSugestedIndexes を参照してください。

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

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

--clusterName

string

true

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

--groupId

string

true

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

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

-h, --help

false

listClusterSugestedIndexes のヘルプ

--namespaces

.

false

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

--出力

string

false

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

-- output-file

string

false

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

--processIds

mongod

false

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

--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: "2024-08-05"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2024-08-05"

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

以下の コマンドを実行します。

atlas api performanceAdvisor listClusterSuggestedIndexes --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8

項目一覧