Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / /

1 つのプロジェクトのすべてのログ コレクション ジョブを取得

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

注意

グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。

ログ コレクション ジョブを作成すると、 MongoDB Ops Managerはバックグラウンド ジョブを開始して、指定されたMongoDB Ops Manager配置からログをダウンロードします。 このエンドポイントを使用して、指定されたMongoDB Ops Managerプロジェクトのすべてのログ コレクション ジョブを検索します。

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

GET /groups/{GROUP-ID}/logCollectionJobs
名前
タイプ
必要性
説明
グループ ID
string
必須
ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。
名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

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

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

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

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true
verbose
ブール値
任意
応答にすべての子ジョブを含めるかどうかを示すフラグ。 各ログ コレクション ジョブには、リクエストに含まれる各ログ タイプと MongoDB プロセスの子ジョブが含まれます。
false

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

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

結果は 1 つのログ コレクション ジョブです。

名前
タイプ
説明
Thursday
配列
このリクエストに関連付けられた子ジョブのリスト。 冗長クエリ パラメータをtrueに設定している場合は、 の応答に含まれます。
oldJob[n].errorMessage
string
この子ジョブが失敗した理由を示すエラー メッセージ(該当する場合)。
oldJobs[n].FinishDate
string
ISO8601 のタイムスタンプ この子ジョブが完了したとき、 UTC の日付と時刻形式で表示されるようになりました。
oldJobs[n].hostName
string
子ジョブがログを収集するホストの名前。
oldJobs[n].logCollectionType
string

この子ジョブが収集するログのタイプ。 次のいずれかの値を返します。

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

oldJobs[n].path
string

この子ジョブがログを収集する配置内のプロセスへのパス。 MongoDB Atlas はこれらのパスを使用して、圧縮されたアーカイブ ファイルにディレクトリ階層を構築します。

logCollectionType
パス
AUTOMATION_AGENT
<hostname>/automation_agent
BACKUP_ Agent
<hostname>/automation_agent
MONGOING_Agent
<hostname>/automation_agent
MongoDB
<hostname>/<port>/<mongodb>
FTDC
<hostname>/<port>/<ftdc>
oldJobs[n].startDate
string
ISO8601 のタイムスタンプ この子ジョブが開始されたとき、 UTC の日付と時刻形式。
oldJobs[n].status
string

この子ジョブのステータス。 このリソースは、次のいずれかの値を返します。

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

oldJobs[n].uncompressedDiskspaceBytes
数値
この子ジョブが使用する非圧縮ディスク領域の合計(バイト単位)。
createdDate
string
タイムスタンプ( UNIXエポック からの経過秒数単位) ログ コレクション リクエスト ジョブを作成したとき
expirationDate
string
タイムスタンプ( UNIXエポック からの経過秒数単位) ログ コレクション リクエスト ジョブが期限切れになった場合。
グループ ID
string
ログ収集リクエストに関連付けられた プロジェクト 24を識別する一意の 桁の 16 進数string 。
id
string
ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。
logTypes
配列

このリクエストに含まれるログの種類のリスト。 このリソースは、次の 1 つ以上の値を返します。

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

編集済み
ブール値
リクエストが応答内のメール、ホスト名、 IPアドレス、名前空間をランダムなstring値に置き換えるかどうかを示すフラグ。
resourceName
string
ログをリクエストしたリソースの名前。
resourceType
string

ログをリクエストしたリソースのタイプ。 このリソースは、次のいずれかの値を返します。

  • CLUSTER

  • PROCESS

  • REPLICA_SET

rootResourceName
string
配置の一部に対してログ要求を行った場合の、完全な配置の名前。 配置の一部として、クラスター内のレプリカセット、またはシャーディングされたクラスターの 1 つのシャードにすることができます。
rootResourceType
string

配置の一部に対してログ要求を行った場合の、完全な配置の部分のタイプ。 配置の一部として、クラスター内のレプリカセット、またはシャーディングされたクラスターの 1 つのシャードにすることができます。 このリソースは、次のいずれかの値を返します。

  • CLUSTER

  • PROCESS

  • REPLICA_SET

状態
string

ログ コレクション リクエスト ジョブのステータス。 このリソースは、次のいずれかの値を返します。

  • SUCCESS

  • FAILURE

  • IN_PROGRESS

  • MARKED_FOR_EXPIRY

  • EXPIRED

sizeRequestedPerFileBytes
数値
各ログファイルのサイズ(バイト単位)。
uncompressedSize TotalBytes
数値
このリクエストが返すログ データの非圧縮サイズの合計(バイト単位)。
userId
string
リクエストを実行するユーザーを識別する一意な 24 桁の 16 進数のstring 。
ダウンロードUrl
string
このリクエストからログをダウンロードするインターネット アドレス。
1curl --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?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}
1{
2 "links": [
3 {
4 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100",
5 "rel": "self"
6 }
7 ],
8 "results": [
9 {
10 "childJobs": [
11 {
12 "automationAgentId": "5c810cc4ff7a256345ff97bf",
13 "errorMessage": null,
14 "finishDate": "2019-03-07T12:21:30Z",
15 "hostName": "server1.example.com",
16 "logCollectionType": "AUTOMATION_AGENT",
17 "path": "server1.example.com/automation_agent",
18 "startDate": "2019-03-07T12:21:24Z",
19 "status": "SUCCESS",
20 "uncompressedDiskSpaceBytes": 14686
21 }
22 ],
23 "creationDate": "2019-03-07T12:21:24Z",
24 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download",
25 "expirationDate": "2019-04-06T12:21:24Z",
26 "groupId": "5c8100bcf2a30b12ff88258f",
27 "id": "5c810cc4ff7a256345ff97b7",
28 "logTypes": [
29 "AUTOMATION_AGENT",
30 "MONGODB"
31 ],
32 "redacted": true,
33 "resourceName": "myReplicaSet",
34 "resourceType": "replicaset",
35 "rootResourceName": "myReplicaSet",
36 "rootResourceType": "replicaset",
37 "sizeRequestedPerFileBytes": 1000,
38 "status": "SUCCESS",
39 "uncompressedSizeTotalBytes": 63326,
40 "userId": "5c80f75fcf09a246878f67a4"
41 },
42 {
43 "childJobs": [
44 {
45 "automationAgentId": "5c81086e014b76a3d85e1117",
46 "errorMessage": null,
47 "finishDate": "2019-03-07T12:02:57Z",
48 "hostName": "server1.example.com:27027",
49 "logCollectionType": "MONGODB",
50 "path": "server1.example.com/27027/mongodb",
51 "startDate": "2019-03-07T12:02:54Z",
52 "status": "SUCCESS",
53 "uncompressedDiskSpaceBytes": 9292
54 }
55 ],
56 "creationDate": "2019-03-07T12:02:54Z",
57 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download",
58 "expirationDate": "2019-05-06T12:02:54Z",
59 "groupId": "5c8100bcf2a30b12ff88258f",
60 "id": "5c81086e014b76a3d85e1113",
61 "logTypes": [
62 "MONGODB",
63 "FTDC",
64 "AUTOMATION_AGENT"
65 ],
66 "redacted": false,
67 "resourceName": "myReplicaSet",
68 "resourceType": "replicaset",
69 "rootResourceName": "myReplicaSet",
70 "rootResourceType": "replicaset",
71 "sizeRequestedPerFileBytes": 1000,
72 "status": "IN_PROGRESS",
73 "uncompressedSizeTotalBytes": 44518,
74 "userId": "5c80f75fcf09a246878f67a4"
75 }
76 ],
77 "totalCount": 2
78}

戻る

ログ収集ジョブ