Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas api monitoringAndLogs getIndexMetrics

実験的な : 指定されたプロセス上の 1 つの名前空間とインデックス名について、指定された時間範囲内の Atlas Search メトリクス データ系列を返します。

Atlas Search メトリクス タイプを参照するには、プロジェクト読み取り専用以上のロールが必要です。このコマンドは、OpsID: 'getIndexMetrics' を使用してエンドポイントを呼び出します。フラグ、--ファイルの形式、および例の詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Monitoring-and- Logs/ 操作/getIndexMetrics

コマンド構文
atlas api monitoringAndLogs getIndexMetrics [options]
名前
タイプ
必須
説明

--collectionName

string

true

コレクションを識別する、人間が判読できるラベル

--databaseName

string

true

データベースを識別する、人間が判読できるラベル

--end

string

false

MongoDB Cloud がメトリクスのレポートを停止する日時

-- envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ

--granularity

string

true

Atlas がメトリクスをレポートする間隔を指定する duration

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数の文字列

-h, --help

false

getIndexMetrics のヘルプ

--indexName

string

true

インデックスを識別する、人間が判読できるラベル

--metrics

stringArray

true

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

--出力

string

false

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

-- output-file

string

false

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

--period

string

false

Atlas がメトリクスをレポートする期間

--processId

string

true

MongoDBプロセスを提供するホスト名と IANA ポートの組み合わせ

--start

string

false

MongoDB Cloud がメトリクスのレポートを開始する日時

--version

string

false

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

名前
タイプ
必須
説明

-P, --profile

string

false

項目一覧