注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ログ コレクション ジョブを作成すると、 MongoDB Ops Managerはバックグラウンド ジョブを開始して、指定されたMongoDB Ops Manager配置からログをダウンロードします。 このエンドポイントを使用して、指定されたMongoDB Ops Managerプロジェクトのすべてのログ コレクション ジョブを検索します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobsリクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
verbose | ブール値 | 任意 | 応答にすべての子ジョブを含めるかどうかを示すフラグ。 各ログ コレクション ジョブには、リクエストに含まれる各ログ タイプと MongoDB プロセスの子ジョブが含まれます。 |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答JSONドキュメントには、resultオブジェクトの配列、linkオブジェクトの配列、および検索されたresultオブジェクトの合計数のカウントが含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 つのログ コレクション ジョブです。
名前 | タイプ | 説明 |
|---|---|---|
Thursday | 配列 | このリクエストに関連付けられた子ジョブのリスト。 冗長クエリ パラメータを |
oldJob[n].errorMessage | string | この子ジョブが失敗した理由を示すエラー メッセージ（該当する場合）。 |
oldJobs[n].FinishDate | string | この子ジョブが完了したときの ISO 8601 日付と時刻の形式（UTC）でのタイムスタンプ。 |
oldJobs[n].hostName | string | 子ジョブがログを収集するホストの名前。 |
oldJobs[n].logCollectionType | string | この子ジョブが収集するログのタイプ。 次のいずれかの値を返します。
|
oldJobs[n].path | string | この子ジョブがログを収集する配置内のプロセスへのパス。 MongoDB Atlas はこれらのパスを使用して、圧縮されたアーカイブ ファイルにディレクトリ階層を構築します。
|
oldJobs[n].startDate | string | この子ジョブが開始されたときの ISO 8601 日付と時刻の形式（UTC）でのタイムスタンプ。 |
oldJobs[n].status | string | この子ジョブのステータス。 このリソースは、次のいずれかの値を返します。
|
oldJobs[n].uncompressedDiskspaceBytes | 数値 | この子ジョブが使用する非圧縮ディスク領域の合計（バイト単位）。 |
createdDate | string | |
expirationDate | string | |
グループ 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 | このリクエストからログをダウンロードするインターネット アドレス。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pretty=true"応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "childJobs": [ { "automationAgentId": "5c810cc4ff7a256345ff97bf", "errorMessage": null, "finishDate": "2019-03-07T12:21:30Z", "hostName": "server1.example.com", "logCollectionType": "AUTOMATION_AGENT", "path": "server1.example.com/automation_agent", "startDate": "2019-03-07T12:21:24Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 14686 } ], "creationDate": "2019-03-07T12:21:24Z", "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download", "expirationDate": "2019-04-06T12:21:24Z", "groupId": "5c8100bcf2a30b12ff88258f", "id": "5c810cc4ff7a256345ff97b7", "logTypes": [ "AUTOMATION_AGENT", "MONGODB" ], "redacted": true, "resourceName": "myReplicaSet", "resourceType": "replicaset", "rootResourceName": "myReplicaSet", "rootResourceType": "replicaset", "sizeRequestedPerFileBytes": 1000, "status": "SUCCESS", "uncompressedSizeTotalBytes": 63326, "userId": "5c80f75fcf09a246878f67a4" }, { "childJobs": [ { "automationAgentId": "5c81086e014b76a3d85e1117", "errorMessage": null, "finishDate": "2019-03-07T12:02:57Z", "hostName": "server1.example.com:27027", "logCollectionType": "MONGODB", "path": "server1.example.com/27027/mongodb", "startDate": "2019-03-07T12:02:54Z", "status": "SUCCESS", "uncompressedDiskSpaceBytes": 9292 } ], "creationDate": "2019-03-07T12:02:54Z", "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", "expirationDate": "2019-05-06T12:02:54Z", "groupId": "5c8100bcf2a30b12ff88258f", "id": "5c81086e014b76a3d85e1113", "logTypes": [ "MONGODB", "FTDC", "AUTOMATION_AGENT" ], "redacted": false, "resourceName": "myReplicaSet", "resourceType": "replicaset", "rootResourceName": "myReplicaSet", "rootResourceType": "replicaset", "sizeRequestedPerFileBytes": 1000, "status": "IN_PROGRESS", "uncompressedSizeTotalBytes": 44518, "userId": "5c80f75fcf09a246878f67a4" } ], "totalCount": 2}