atlas api monitoringAndLogs listIndexMetrics

string

true

コレクションを識別する、人間が判読可能なラベル。

string

true

データベースを識別する、人間が判読可能なラベル。

string

false

MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

envelope

false

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

string

true

Atlas がメトリクスをレポートする間隔を指定する期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。

string

true

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

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

false

listIndexMetrics のヘルプ

stringArray

true

関連付けられたデータ系列について MongoDB Atlas がレポートする測定値を格納したリスト。

string

false

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

string

false

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

string

false

Atlas がメトリクスをレポートする期間。このパラメーターは、UTC の ISO 8601 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。

string

true

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

string

false

MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"