実験的な : Performance Advisor が提案するインデックスを返します。
Performance Advisor はMongoDBが遅いと判断したクエリをモニターし、クエリ パフォーマンスを改善するための新しいインデックスを提案します。このリソースを使用するには、リクエスト元のAPIキーにプロジェクトの読み取り専用ロールが必要です。このコマンドは、OperationID: 'listSugestedIndexes' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Performance-Advisor/ 操作/listSggerstedIndexes
構文
atlas api performanceAdvisor listSuggestedIndexes [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--duration | 整数 | false | クエリがクラスター内の管理対象名前空間から推奨インデックスを検索する時間の長さ |
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数の文字列 |
-h, --help | false | listSugestedIndexes のヘルプ | |
--includeCount | false | レスポンスがレスポンス内の項目の総数（totalCount）を返すかどうかを示すフラグ | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりの項目の数 |
--nExamples | 整数 | false | 推奨インデックスの恩恵を受ける例クエリの最大数 |
--nIndexes | 整数 | false | 推奨するインデックスの最大数を示す数値 |
--namespaces | stringArray | false | 推奨されたインデックスを検索する名前空間 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pageNum | 整数 | false | レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--processId | string | true | MongoDBプロセスを提供するホストとポートの組み合わせ |
--since | 整数 | false | クエリが推奨インデックスを取得する日時 |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |