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 collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements

パブリック プレビュー:フィードバックを提供してください : 指定された名前空間に対するコレクション統計レイテンシのプロセス レベルの測定値一覧を取得します。

パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

1このコマンドは自動生成され、:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-v2 / 操作/operation-getcollstatslatencynamespacehostmeasurements 。

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

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

--collectionName

string

true

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

--databaseName

string

true

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

--end

string

false

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

-- envelope

envelope

false

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

--groupId

string

true

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

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

-h, --help

false

getCollStatsレイテンシ名前空間ホスト測定値 のヘルプ

--metrics

stringArray

false

関連するデータ シリーズについて取得するメトリクスを含むリスト。このパラメーターを設定しない場合、このリソースはすべてのコレクション統計レイテンシのメトリクスに対するデータ シリーズを返します。

-o, --output

string

false

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

-- outputFile

string

false

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

--period

string

false

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

--processId

string

true

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

--start

string

false

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

--version

string

false

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

名前
タイプ
必須
説明

-P, --profile

string

false

atlas api collectionLevelMetrics getCollStatsLatencyNamespaceHostMeasurements --version 2023-11-15 --collectionName mycoll --databaseName mydb --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --processId my.host.name.com:27017

戻る

getCollStatsLatencyNamespaceClusterMeasurements

項目一覧