AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
Docs Menu

Atlas API performanceAdvisor listClusterSugestedIndexes

Performance Advisor が提案するインデックスを返します。

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/operation-listgroupclusterperformanceadvisorsuggestedindexes.

詳細と例については、上記のリンクで参照されている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> と記述されます。複数の名前空間を含めるには、各名前空間の間をアンパサンド (&) で区切って、パラメーターを複数回渡します。このパラメーターを省略すると、すべての名前空間の結果が返されます。

-o, --output

string

false

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

-- outputFile

string

false

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

--processIds

processId

false

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

--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 バージョン [オプション: "2024-08-05"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの 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