Atlas API performanceAdvisor listS suggestedIndexes

--duration

整数

false

クエリがクラスター内の管理対象名前空間から推奨インデックスを検索する時間の長さ。このパラメータは、その値をミリ秒単位で表します。

• sinceパラメーターを指定しない場合、エンドポイントは現在の時刻より前の期間に該当するデータを返します。

• durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--groupId

string

true

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

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

-h, --help

false

listSugestedIndexes のヘルプ

--includeCount

totalCount

false

レスポンスがレスポンス内のアイテムの総数（totalCount）を返すかどうかを示すフラグ。

--itemsPerPage

整数

false

レスポンスが返す 1 ページあたりのアイテムの数。

--nExamples

整数

false

推奨インデックスの恩恵を受けるクエリ例の最大数。

--nIndexes

整数

false

推奨するインデックスの最大数を示す数値。

--namespaces

.

false

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

-o, --output

string

false

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

-- outputFile

string

false

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

--pageNum

整数

false

レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

--pretty

false

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

--processId

mongod

true

MongoDBプロセスを提供するホストとポートの組み合わせ。ホストはMongoDBプロセス（mongodまたは mongos）を実行するホストのホスト名、FQDN、IPv4 アドレス、または IPv6 アドレスである必要があります。ポートはMongoDBプロセスがリクエストをリッスンする IANA ポートである必要があります。

--since

整数

false

クエリが推奨インデックスを取得する日時。このパラメーターは、[UNIX エポック]（ https://en.wiki.org/wiki/Unix_time ）から経過したミリ秒数で値を表します。

• durationパラメーターを指定しない場合、エンドポイントはsince値から現在の時刻までのデータを返します。

• durationパラメーターもsinceパラメーターも指定しない場合、エンドポイントは過去 24 時間のデータを返します。

--version

string

false

Atlas API エンドポイントを呼び出すときに使用する API バージョン [オプション: "2023-01-01"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2023-01-01" です。