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 getDiskMeasurements

パブリック プレビュー: にフィードバックを提供してください: 指定されたプロジェクトの指定されたホストの、1 つのディスクまたはパーティションの測定値を返します。

戻り値は、次のいずれかになります。

MongoDB プロセスに使用されるディスク パーティションの I/O 操作のスループット

パーティションがリクエストを発行して処理した時間の割合

MongoDB プロセスに使用されるディスク パーティションの操作タイプごとのレイテンシ

MongoDBプロセスに使用されたディスク パーティション上の空きディスク領域と使用済みディスク領域の量

このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Monitoring- と対応していますおよび -Logs/操作/getDiskメジャーメント。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

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

--end

string

false

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

-- envelope

envelope

false

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

--granularity

string

true

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

--groupId

string

true

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

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

-h, --help

false

getDiskメジャーメントのヘルプ

--m

m

false

このMongoDBプロセスにリクエスト1 つ以上の測定タイプ。省略すると、リソースはすべての測定値を返します。m に複数の値を指定するには、値ごとに m パラメーターを繰り返します。指定されたホストに適用する測定値を指定します。無効な測定値を指定した場合、 MongoDB Cloud はエラーを返します。

--出力

string

false

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

-- output-file

string

false

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

-- partitionName

string

true

測定が適用されるディスクまたはパーティションの、人間が判読可能なラベル。

--period

string

false

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

--pretty

false

レスポンス本体を <aクエリを実行するかどうかを示すフラグtarget ` ` Sharding</a>

--processId

mongod

true

MongoDBプロセスを提供するホスト名と IANA(Internet Assigned Numbers Authority、インターネット番号割当機関)ポートの組み合わせ。ホストはMongoDBプロセス(mongodまたは mongos)を実行するホストのホスト名、完全修飾ドメイン名(FQDN)、またはインターネット プロトコル アドレス(IPv4 または IPv6)である必要があります。ポートはMongoDBプロセスがリクエストをリッスンする IANA ポートである必要があります。

--start

string

false

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

--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 を参照してください。

以下の コマンドを実行します。

atlas api monitoringAndLogs getDiskMeasurements --version 2023-01-01 --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --partitionName [partitionName] --period PT10H --pretty false --processId mongodb.example.com:27017

項目一覧