/ /

Ops Manager サーバーのログ収集ジョブの作成

Ops Managerサーバーのログコレクションジョブを作成すると、Ops Manager はバックグラウンドタスクを開始して、ターゲットサーバーからリクエストされたログを収集します。各サーバーはログをローカルに収集し、それらを圧縮して暗号化し、その結果をアプリケーションデータベースに保存します。このエンドポイントを使用して新しいジョブを作成します。

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

Resource

POST /admin/omLogCollectionJobs

必須のロール

このエンドポイントを呼び出す APIキーに Global Ownerロールが必要です。

Request Parameters

リクエストパスパラメーター

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

リクエストクエリパラメータ

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

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

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

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

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

名前	タイプ	必要性	説明
`servers`	文字列の配列	任意	`serverId`アクティブな Ops Manager サーバーを一覧表示するによって返される値のリスト。このフィールドを省略するか、空の配列を渡すと、Ops Manager はアクティブなすべてのサーバーからログを収集します。
`logTypes`	文字列の配列	任意	収集するログの種類。各要素は、次のいずれかの値である必要があります。 `APPLICATION` `HTTP_ACCESS` `MIGRATION` このフィールドを省略するか、空の配列を渡すと、Ops Manager はすべてのログタイプを収集します。
`sizeRequestedPerFileBytes`	数値	任意	サーバーごとのログタイプごとの最大非圧縮サイズ（バイト単位）。 0 より大きくする必要があります。このフィールドを省略すると、Ops Manager は残りの構成済みストレージをリクエストされたサーバーとログの種類全体に自動的に割り当てます。
`logCollectionFromDate`	string	任意	収集する時間範囲の開始。 ISO 8601 UTC形式。このフィールドを設定する場合は、`logCollectionToDate` も設定する必要があります。
`logCollectionToDate`	string	任意	収集する時間範囲の終了。 ISO 8601 UTC形式。このフィールドを設定する場合は、`logCollectionFromDate` も設定する必要があります。

注意

サイズ制限と時間範囲を組み合わせると、Ops Manager は安全性上限としてサイズ制限を適用します。時間範囲のログがサイズ制限を超える場合、Ops Manager は最新のログをサイズ制限まで返し、影響を受ける子ジョブの sizeLimitHit を true に設定します。時間範囲と一緒に sizeRequestedPerFileBytes を省略すると、Ops Manager は残りの構成済みストレージをリクエストされたサーバーとログのタイプに自動的に割り当てます。

MongoDB Ops Manager は、次のいずれかのルールに違反する作成リクエストを拒否します。

ルール	エラーコード	HTTP status
`sizeRequestedPerFileBytes` は 0 より大きくなければなりません。	`INVALID_LOG_REQUEST_SIZE`	400
`logCollectionFromDate` と `logCollectionToDate` は一緒に設定する必要があります。	`OM_LOG_INCOMPLETE_TIME_RANGE`	400
`logCollectionFromDate` must precede `logCollectionToDate`.	`OM_LOG_INVALID_TIME_RANGE`	400
`logCollectionFromDate` は、将来にわたってであってはなりません。	`OM_LOG_TIME_RANGE_IN_FUTURE`	400
期間は 7 日を超えてはなりません。	`OM_LOG_TIME_RANGE_TOO_LARGE`	400
時間範囲は、Ops Manager 管理者が構成した最大ログ履歴よりも早く開始してはなりません。	`OM_LOG_TIME_RANGE_TOO_OLD`	400
`servers` の各値は、登録されアクティブな Ops Managerサーバーを識別する必要があります。	`INACTIVE_SERVER` or `INVALID_SERVER`	400
同時ジョブの数は 4 を超えてはなりません。	`TOO_MANY_OM_LOG_JOBS`	429
推定されるストレージは、Ops Manager 管理者がログコレクション用に構成したストレージ制限を超えてはなりません。	`OM_LOG_STORAGE_LIMIT_EXCEEDED`	413

応答

名前	タイプ	説明
`id`	string	新しい Ops Managerサーバーのログコレクションジョブの一意の識別子です。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?pretty=true" \
     --data '
       {
         "servers": [
           "om-server-1.example.com",
           "om-server-2.example.com"
         ],
         "logTypes": ["APPLICATION", "HTTP_ACCESS"],
         "sizeRequestedPerFileBytes": 5242880,
         "logCollectionFromDate": "2026-04-13T10:00:00Z",
         "logCollectionToDate": "2026-04-14T10:00:00Z"
       }'

応答例

応答ヘッダー

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 201 Created
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}

レスポンス本体

{ "id": "675a1234567890abcdef1234" }

戻る

アクティブなサーバーを一覧表示する

すべてのジョブを取得