1 つのログコレクションジョブを取得

項目一覧

Resource

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

注意

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

ログコレクションジョブを作成すると、Cloud Manager は指定された Cloud Manager の配置からログをダウンロードするためのバックグラウンドジョブを開始します。このエンドポイントを使用して、一意の識別子で 1 つのログコレクションジョブを検索します。

ベース URL: https://cloud.mongodb.com/api/public/v 1.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レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで"envelope" : trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

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

なし

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

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

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 。

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

このリクエストからログをダウンロードするインターネットアドレス。

logCollectionFromDate

string

ISO8601 でのログコレクションの開始日時形式（UTC）。

logCollectionToDate

string

ISO8601 のログコレクションの終了日時形式（UTC）。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{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}

レスポンス本体

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://cloud.mongodb.com/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 }

戻る

すべてのジョブを取得

ログのダウンロード

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&pretty=true"

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://cloud.mongodb.com/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	}

注意

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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