指定されたシャーディングされたクラスターの各シャードについて、要求された測定値の時系列データを返します。シャードおよび測定値ごとに1つの時系列データが得られます。
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
各シャードのシリーズは、nodeType で選択されたメンバー プロセスの読み取り値を平均します。各シリーズは、開始から終了まで、粒度間隔ごとに 1 つのデータ ポイントを保持します。MongoDB Cloud にその間隔の読み取り値がない場合、データ ポイントの値は null になります。これには、クラスターまたはシャードが作成されてからメトリックが収集される前の最初の数分間も含まれるため、null を負荷ゼロと解釈してはいけません。期間を設定するか、開始と終了の両方を設定します。どちらも設定されていない場合、応答は最後の 1 時間を対象とします。ウィンドウと粒度によってシリーズごとに1000超えるデータ ポイントが生成されるリクエストは拒否されます。
このコマンドは自動生成されたものであり、1:1 は Atlas API エンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclustershardmetricmeasurements. に対応しています。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
コマンド構文
atlas api shardingInsights listShardMetricMeasurements [options]オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | クラスターを識別する人間が判読できるラベル。 |
--end | string | false | MongoDB Cloud がメトリクスのレポートを停止する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--granularity | string | false | 連続するデータポイント間の間隔をISO 8601形式で指定します。省略した場合、MongoDB Cloudはウィンドウの幅から解像度を選択します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | listShardMetricMeasures のヘルプ | |
--m | m | false | 返される測定値は1つ以上です。省略した場合、リソースはすべての測定値を返します。mに複数の値を指定するには、各値に対して |
--nodeType | string | 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 期間形式で値を表します。start と end を設定しない場合は、このパラメーターを含めます。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--start | string | false | MongoDB Cloud がメトリクスのレポートを開始する日時。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。period を設定しない場合は、このパラメーターを含めます。 |
--version | string | false | Atlas API エンドポイントを呼び出すときに使用する API バージョン [オプション: "2025-03-12"]。ユーザーが設定しない場合は、最新バージョンまたはプロファイルの api_version 構成値が設定されている場合はその値がデフォルトになります。この値のデフォルトは "2025-03-12" です。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
atlas api shardingInsights listShardMetricMeasurements --version 2025-03-12 --clusterName [clusterName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H