/ /

/ /

すべての Ops Manager サーバーのログ収集ジョブを取得する

このエンドポイントを使用して、すべての Ops Managerサーバーログコレクションジョブを取得します。

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

Resource

GET /admin/omLogCollectionJobs

必須のロール

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

Request Parameters

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

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

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

名前	タイプ	必要性	説明	default
`pageNum`	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
`itemsPerPage`	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
`verbose`	ブール値	任意	応答にすべての子ジョブを含めるかどうかを示すフラグ。 MongoDB Ops Managerサーバーの各ログコレクションジョブには、リクエストに含まれるサーバーとログのタイプの各組み合わせに対する子ジョブがあります。	`false`
`pretty`	ブール値	任意	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。	`false`
`envelope`	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope=true` を設定します。	`false`

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

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

応答

応答には、結果オブジェクトの配列、リンクオブジェクトの配列、および検索された結果オブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	Ops Managerサーバーのログコレクションジョブの配列。結果の埋め込みドキュメントを参照してください。
`links`	配列	サブリソースまたは関連リソースへの 1 つ以上のリンクの配列。 URL 間の関係は、Web リンク仕様に従います（RFC5988 ）。
`totalCount`	数値	結果セット内の項目の合計数。ページ分割すると、`results` のサイズを超える可能性があります。

結果埋め込みドキュメント

各 results 要素は 1 つの 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?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}

レスポンス本体

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"],
      "sizeRequestedPerFileBytes": 5242880,
      "logCollectionFromDate": null,
      "logCollectionToDate": null,
      "uncompressedSizeTotalBytes": 8388608,
      "sizeLimitHit": true,
      "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": true,
          "uncompressedDiskspaceBytes": 5242880
        },
        {
          "serverId": "om-server-1.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:05Z",
          "finishDate": "2026-04-13T10:01:45Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 2097152
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "APPLICATION",
          "status": "FAILURE",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:00:45Z",
          "errorMessage": "Failed to read log file: permission denied",
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 0
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:02:00Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 1048576
        }
      ]
    }
  ],
  "totalCount": 1
}

戻る

作成

1 つのジョブを取得

Resource

必須のロール

Request Parameters

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

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

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

応答

結果 埋め込みドキュメント

Thursday

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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

結果埋め込みドキュメント