日次使用状況スナップショットの生成
{3 が {5MongoDB Usage UI
Onに設定されている場合は、このエンドポイントを してtriggerMongoDB Ops Manager に次のように指示できます。
スナップショットを生成します。 すべてのプロジェクトと組織に属するすべての配置のこのスナップショットには、各
mongod
およびmongos
プロセスの現在の情報が含まれています。メモリ統計
date
組織
プロジェクト
IP
IANAポート
割り当てを計算します。 これにより、
assignment
コレクションにデータが入力されます。 エンドポイントにより、 MongoDB Ops Managerはその日のスナップショットを確認し、割り当てられたサーバータイプで各プロセスをコピーします。 MongoDB Ops Managerは、ホストからプロセスのサーバー タイプを検出します。 ホストのサーバー タイプは、管理ページで設定された可能性があります。 ホストのサーバータイプが設定されていない場合、 MongoDB Ops Managerは、ホストがそのホストに作成されたときにプロジェクトのデフォルトのサーバータイプを割り当てます。
assignments
コレクションに割り当てがないが、MongoDB 使用状況管理 UI を表示する場合は、このエンドポイントを呼び出します。 これは、次の場合に発生する可能性があります。
MongoDB Usage Data Collection
を有効にしましたが、データを収集する自動ジョブはまだ初めて実行されます。assignments
コレクションを削除または空にしました。使用量データを毎日ではなく 1 回収集したいため、
MongoDB Usage Data Collection
を有効にしませんでした。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
必要なロール
このリソースでは、 API キーにGlobal Owner
ロールが必要です。
Resource
POST /usage/dailyCapture
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号(1 インデックス ベース)。 |
| ||||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 |
| ||||||
pretty | ブール値 | レスポンス本体を pretty-print にするかどうかを示します 形式。 |
| ||||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントには、応答要素がありません。
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/dailyCapture?pretty=true"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
このエンドポイントは、レスポンス本体を返しません。