Performance Advisor が削除を提案するインデックスを返します。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
Performance Advisor は、未使用で冗長な非表示のインデックスを削除して、書き込み (write) パフォーマンスを向上させ、ストレージ容量を増やすことを提案します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーに Project Read Only ロールが必要です。
このコマンドは自動生成されており、1:1 は Atlas API のエンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterperformanceadvisordropindexsuggestions. に対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api performanceAdvisor listDropIndexSuggestions [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | クラスターを識別する人間が判読できるラベル。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | listドロップインデックスの作成に役立つ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--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 listDropIndexSuggestions --version 2024-08-05 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8