注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
このエンドポイントとなる接続されたデバイスを使用して、新しいログ コレクション ジョブを作成します。ログ コレクション ジョブを作成すると、MongoDB Ops Manager は指定された MongoDB Ops Manager 配置からログをダウンロードするバックグラウンド ジョブを開始します。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{GROUP-ID}/logCollectionJobsリクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
resourceType | string | 必須 | ログを収集するリソースのタイプ。 次のいずれかの値である必要があります。
|
resourceName | string | 必須 | ログを収集するリソースの名前。 リソース タイプ によって値が定義されます。
|
sizeRequestedPerFileBytes | 数値 | 必須 | 各ログファイルのサイズ（バイト単位）。 |
logTypes | 配列 | 必須 | 収集するログのタイプを指定する文字列の配列。 各配列要素は、次の値のいずれかである必要があります。
|
編集済み | ブール値 | 必須 |
|
logCollectionFromDate | integer | 任意 | UNIXエポックからのミリ秒単位で、このログを開始する日付と時刻。 |
logCollectionToDate | integer | 任意 | UNIX エポックからのミリ秒単位で、このログを終了する日時。 |
応答
名前 | タイプ | 説明 |
|---|---|---|
id | string | 作成されたログ コレクション ジョブの一意の識別子です。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true" \ --data ' { "resourceType": "PROCESS", "resourceName": "my_deployment_1", "redacted": true, "sizeRequestedPerFileBytes": 10000000, "logTypes": [ "FTDC", "MONGODB", "AUTOMATION_AGENT" ] }'応答例
応答ヘッダー
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 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "id": "5c81086e014b76a3d85e1113" }