Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / /

日次使用状況スナップショットの生成

項目一覧

  • 必要なロール
  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

{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 を表示する場合は、このエンドポイントを呼び出します。 これは、次の場合に発生する可能性があります。

  1. MongoDB Usage Data Collectionを有効にしましたが、データを収集する自動ジョブはまだ初めて実行されます。

  2. assignmentsコレクションを削除または空にしました。

  3. 使用量データを毎日ではなく 1 回収集したいため、 MongoDB Usage Data Collectionを有効にしませんでした。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

このリソースでは、 API キーにGlobal Ownerロールが必要です。

POST /usage/dailyCapture

このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。

次のクエリ パラメータは 任意です。

名前
タイプ
説明
default

pageNum

integer

ページ番号(1 インデックス ベース)。

1

itemsPerPage

integer

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

false

envelope

ブール値

応答をエンベロープでラップするかどうかを示します。

一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前
説明

status

HTTPレスポンス コード

content

期待される応答本体

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

なし

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

このエンドポイントには、応答要素がありません。

1curl --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"
HTTP/1.1 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
HTTP/1.1 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}

このエンドポイントは、レスポンス本体を返しません。

戻る

1 つの組織のサーバー タイプを更新