/ /

/ /

1 つの Ops Manager サーバーのログ収集ジョブを取得

このエンドポイントを使用して、識別子ごとに 1 つの Ops Managerサーバーログコレクションジョブを検索します。

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

Resource

GET /admin/omLogCollectionJobs/{JOB-ID}

必須のロール

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

Request Parameters

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

名前	タイプ	必要性	説明
`JOB-ID`	string	必須	24Ops Managerサーバーログコレクションジョブを識別する一意の桁の 16 進数文字列。ジョブIDを見つけるには、「すべての Ops Manager サーバーログコレクションジョブの取得」を呼び出します。

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

名前	タイプ	必要性	説明	default
`verbose`	ブール値	任意	応答にすべての子ジョブを含めるかどうかを示すフラグ。	`false`
`pretty`	ブール値	任意	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。	`false`
`envelope`	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope=true` を設定します。	`false`

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

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

応答

レスポンスは、単一の Ops Managerサーバーログコレクションジョブを返します。

名前	タイプ	説明
`id`	string	このジョブを識別する一意の 24 桁の 16 進数文字列。
`status`	string	ジョブのステータス。次のいずれかの値を返します。 `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`creationDate`	string	Ops Manager がジョブを作成したときのタイムスタンプ（ISO 8601 UTC形式）。
`expirationDate`	string	ジョブが期限切れになり、Ops Manager がそのデータを自動的に削除するときのタイムスタンプ（ISO 8601 UTC形式）。
`finishDate`	string	ジョブが完了したときのタイムスタンプ（ISO 8601 UTC形式）。ジョブの進行中、`null`
`servers`	文字列の配列	`serverId`このリクエストに含まれる値のリスト。アクティブな Ops Manager サーバーを一覧表示するによって返されます。
`logTypes`	文字列の配列	このリクエストに含まれるログの種類。次の値の 1 つ以上を返します。 `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`sizeRequestedPerFileBytes`	数値	サーバーごとのログタイプごとの最大要求サイズ（バイト単位）。
`logCollectionFromDate`	string	時間範囲フィルターの開始。 ISO 8601 UTC形式。リクエストで時間範囲が指定されていない場合は、`null`。
`logCollectionToDate`	string	時間範囲フィルターの末尾。 ISO 8601 UTC形式。リクエストで時間範囲が指定されていない場合は、`null`。
`uncompressedSizeTotalBytes`	数値	収集されたログデータの合計非圧縮サイズ（バイト単位）。
`sizeLimitHit`	ブール値	データが `sizeRequestedPerFileBytes` に達したため、MongoDB Ops Manager が子ジョブの収集データを切り捨てているかどうかを示すフラグ。
`downloadUrl`	string	アーカイブをダウンロードできるURL 。「 Ops Manager サーバーログのダウンロード」を参照してください。
`childJobs`	配列	このリクエストに関連付けられた子ジョブのリスト。 MongoDB Ops Manager には、`verbose=true` を設定した場合にのみこのフィールドが含まれます。

Thursday

各子ジョブは、1 つのサーバーと 1 つのログタイプのログコレクションタスクを表します。

名前	タイプ	説明
`childJobs[n].serverId`	string	`serverId` この子ジョブがログを収集する Ops Managerサーバーの
`childJobs[n].logCollectionType`	string	この子ジョブが収集するログの種類。次のいずれかの値を返します。 `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`childJobs[n].status`	string	この子ジョブのステータス。次のいずれかの値を返します。 `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`childJobs[n].startDate`	string	この子ジョブが開始されたときのタイムスタンプ（ISO 8601 UTC形式）。
`childJobs[n].finishDate`	string	この子ジョブが完了したときのタイムスタンプ（ ISO 8601 UTC形式）。子ジョブの進行中、 `null`
`childJobs[n].errorMessage`	string	この子ジョブが失敗した理由を説明するエラーメッセージ。子ジョブが失敗しなかった場合は、`null`。
`childJobs[n].sizeLimitHit`	ブール値	データが `sizeRequestedPerFileBytes` に達したため、MongoDB Ops Manager がこの子ジョブの収集データを切り捨てしたかどうかを示すフラグ。
`childJobs[n].uncompressedDiskspaceBytes`	数値	この子ジョブが使用する非圧縮ディスク領域の合計（バイト単位）。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/{JOB-ID}?verbose=true&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}

レスポンス本体

{
  "id": "675a1234567890abcdef1234",
  "status": "SUCCESS",
  "creationDate": "2026-04-13T10:00:00Z",
  "expirationDate": "2026-04-20T10:00:00Z",
  "finishDate": "2026-04-13T10:02:30Z",
  "servers": [
    "om-server-1.example.com",
    "om-server-2.example.com"
  ],
  "logTypes": ["APPLICATION", "HTTP_ACCESS", "MIGRATION"],
  "sizeRequestedPerFileBytes": 5242880,
  "logCollectionFromDate": "2026-04-12T00:00:00Z",
  "logCollectionToDate": "2026-04-13T00:00:00Z",
  "uncompressedSizeTotalBytes": 15728640,
  "sizeLimitHit": false,
  "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/675a1234567890abcdef1234:download",
  "childJobs": [
    {
      "serverId": "om-server-1.example.com",
      "logCollectionType": "APPLICATION",
      "status": "SUCCESS",
      "startDate": "2026-04-13T10:00:05Z",
      "finishDate": "2026-04-13T10:01:30Z",
      "errorMessage": null,
      "sizeLimitHit": false,
      "uncompressedDiskspaceBytes": 2621440
    },
    {
      "serverId": "om-server-1.example.com",
      "logCollectionType": "HTTP_ACCESS",
      "status": "SUCCESS",
      "startDate": "2026-04-13T10:00:05Z",
      "finishDate": "2026-04-13T10:02:00Z",
      "errorMessage": null,
      "sizeLimitHit": false,
      "uncompressedDiskspaceBytes": 1310720
    },
    {
      "serverId": "om-server-1.example.com",
      "logCollectionType": "MIGRATION",
      "status": "SUCCESS",
      "startDate": "2026-04-13T10:00:05Z",
      "finishDate": "2026-04-13T10:01:15Z",
      "errorMessage": null,
      "sizeLimitHit": false,
      "uncompressedDiskspaceBytes": 524288
    },
    {
      "serverId": "om-server-2.example.com",
      "logCollectionType": "APPLICATION",
      "status": "SUCCESS",
      "startDate": "2026-04-13T10:00:10Z",
      "finishDate": "2026-04-13T10:02:30Z",
      "errorMessage": null,
      "sizeLimitHit": false,
      "uncompressedDiskspaceBytes": 3145728
    }
  ]
}

戻る

すべてのジョブを取得

ログのダウンロード

Resource

必須のロール

Request Parameters

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

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

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

応答

Thursday

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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