1 つのログ コレクション ジョブを取得
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ログ コレクション ジョブを作成すると、 MongoDB Ops Managerはバックグラウンド ジョブを開始して、指定されたMongoDB Ops Manager配置からログをダウンロードします。 このエンドポイントを使用して、一意の識別子で 1 つのログ コレクション ジョブを検索します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。 |
JOB-ID | string | 必須 | 再試行するログ コレクション ジョブを識別する一意の 24 桁の 16 進数string 。 プロジェクトに関連付けられている ID を取得するには、 「1 つのプロジェクトのすべてのログ コレクション ジョブを取得」エンドポイントを使用します。 |
リクエスト クエリ パラメータ
名前 | タイプ | 説明 | default | ||||
|---|---|---|---|---|---|---|---|
pageNum | integer | ページ番号（1 インデックス ベース）。 | 1 | ||||
itemsPerPage | integer | 1 ページあたりに返す項目の数は最大 500 です。 | 100 | ||||
pretty | ブール値 | レスポンス本体を pretty-print に含めるかどうかを示します 形式。 | false | ||||
envelope | ブール値 | 応答をエンベロープでラップするかどうかを示します。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
結果のリストを返すエンドポイントの場合、 | なし |
verbose | ブール値 | true の場合、 はレスポンス内のすべての子ジョブを返します。 ログ コレクション ジョブには、リクエストに含まれる各ログのタイプと MongoDB プロセスの子ジョブが含まれます。 | false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Thursday | 配列 | このリクエストに関連付けられた子ジョブのリスト。 冗長クエリ パラメータを trueに設定している場合は、 の応答に含まれます。 | ||||||||||||
oldJob[n].errorMessage | string | この子ジョブが失敗した理由を示すエラー メッセージ（該当する場合）。 | ||||||||||||
oldJobs[n].FinishDate | string | ISO8601 のタイムスタンプ この子ジョブが完了したとき、 UTC の日付と時刻形式で表示されるようになりました。 | ||||||||||||
oldJobs[n].hostName | string | 子ジョブがログを収集するホストの名前。 | ||||||||||||
oldJobs[n].logCollectionType | string | この子ジョブが収集するログのタイプ。 次のいずれかの値を返します。
| ||||||||||||
oldJobs[n].path | string | この子ジョブがログを収集する配置内のプロセスへのパス。 MongoDB Atlas はこれらのパスを使用して、圧縮されたアーカイブ ファイルにディレクトリ階層を構築します。
| ||||||||||||
oldJobs[n].startDate | string | ISO8601 のタイムスタンプ この子ジョブが開始されたとき、 UTC の日付と時刻形式。 | ||||||||||||
oldJobs[n].status | string | この子ジョブのステータス。 このリソースは、次のいずれかの値を返します。
| ||||||||||||
oldJobs[n].uncompressedDiskspaceBytes | 数値 | この子ジョブが使用する非圧縮ディスク領域の合計（バイト単位）。 | ||||||||||||
createdDate | string | タイムスタンプ（ UNIXエポック からの経過秒数単位） ログ コレクション リクエスト ジョブを作成したとき | ||||||||||||
expirationDate | string | タイムスタンプ（ UNIXエポック からの経過秒数単位） ログ コレクション リクエスト ジョブが期限切れになった場合。 | ||||||||||||
グループ ID | string | ログ収集リクエストに関連付けられた プロジェクト 24を識別する一意の 桁の 16 進数string 。 | ||||||||||||
id | string | ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。 | ||||||||||||
logTypes | 配列 | このリクエストに含まれるログの種類のリスト。 このリソースは、次の 1 つ以上の値を返します。
| ||||||||||||
編集済み | ブール値 | リクエストが応答内のメール、ホスト名、 IPアドレス、名前空間をランダムなstring値に置き換えるかどうかを示すフラグ。 | ||||||||||||
resourceName | string | ログをリクエストしたリソースの名前。 | ||||||||||||
resourceType | string | ログをリクエストしたリソースのタイプ。 このリソースは、次のいずれかの値を返します。
| ||||||||||||
rootResourceName | string | 配置の一部に対してログ要求を行った場合の、完全な配置の名前。 配置の一部として、クラスター内のレプリカセット、またはシャーディングされたクラスターの 1 つのシャードにすることができます。 | ||||||||||||
rootResourceType | string | 配置の一部に対してログ要求を行った場合の、完全な配置の部分のタイプ。 配置の一部として、クラスター内のレプリカセット、またはシャーディングされたクラスターの 1 つのシャードにすることができます。 このリソースは、次のいずれかの値を返します。
| ||||||||||||
状態 | string | ログ コレクション リクエスト ジョブのステータス。 このリソースは、次のいずれかの値を返します。
| ||||||||||||
sizeRequestedPerFileBytes | 数値 | 各ログファイルのサイズ（バイト単位）。 | ||||||||||||
uncompressedSize TotalBytes | 数値 | このリクエストが返すログ データの非圧縮サイズの合計（バイト単位）。 | ||||||||||||
userId | string | リクエストを実行するユーザーを識別する一意な 24 桁の 16 進数のstring 。 | ||||||||||||
ダウンロードUrl | string | このリクエストからログをダウンロードするインターネット アドレス。 |
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&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}
レスポンス本体
1 { 2 "childJobs": [ 3 { 4 "automationAgentId": "5c81086e014b76a3d85e1123", 5 "errorMessage": null, 6 "finishDate": "2019-03-07T12:02:57Z", 7 "hostName": "server1.example.com", 8 "logCollectionType": "AUTOMATION_AGENT", 9 "path": "server1.example.com/automation_agent", 10 "startDate": "2019-03-07T12:02:54Z", 11 "status": "SUCCESS", 12 "uncompressedDiskSpaceBytes": 12827 13 }, 14 { 15 "automationAgentId": "5c81086e014b76a3d85e1117", 16 "errorMessage": null, 17 "finishDate": "2019-03-07T12:02:57Z", 18 "hostName": "server1.example.com:27027", 19 "logCollectionType": "MONGODB", 20 "path": "server1.example.com/27027/mongodb", 21 "startDate": "2019-03-07T12:02:54Z", 22 "status": "SUCCESS", 23 "uncompressedDiskSpaceBytes": 9292 24 }, 25 ... 26 ], 27 "creationDate": "2019-03-07T12:02:54Z", 28 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", 29 "expirationDate": "2019-05-06T12:02:54Z", 30 "groupId": "5c8100bcf2a30b12ff88258f", 31 "id": "5c81086e014b76a3d85e1113", 32 "logTypes": [ 33 "AUTOMATION_AGENT", 34 "MONGODB", 35 "FTDC" 36 ], 37 "redacted": false, 38 "resourceName": "myReplicaSet", 39 "resourceType": "replicaset", 40 "rootResourceName": "myReplicaSet", 41 "rootResourceType": "replicaset", 42 "sizeRequestedPerFileBytes": 1000, 43 "status": "IN_PROGRESS", 44 "uncompressedSizeTotalBytes": 44518, 45 "userId": "5c80f75fcf09a246878f67a4" 46 }