ログ収集ジョブからのログのダウンロード
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ログ コレクション ジョブを作成すると、 MongoDB Ops Managerはバックグラウンド ジョブを開始して、指定されたMongoDB Ops Manager配置からログをダウンロードします。 このエンドポイントを使用して、指定されたジョブに関連付けられているすべてのログの.tar.gzファイルストリームをダウンロードします。
成功したログ コレクション ジョブと失敗したログ コレクション ジョブの両方からログをダウンロードできます。 ジョブが失敗した場合、成功したすべてのコンポーネントがダウンロードされます。 ログは、リクエストが実行されたのと同じディレクトリにダウンロードされ、 MongoDB Ops Manager UI を通じてログをダウンロードするときに使用されるのと同じ形式でダウンロードされます。
例
hostname/ automation_agent/ Automation-agent-verbose.log.2019-01-... mongos/ ... myShard_1/ 27017/ ... 27018/ ...
EXPIREDまたはIN_PROGRESS状態のジョブからログをダウンロードすることはできません。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
グループ ID | string | 必須 | ログ コレクション リクエスト ジョブを識別する一意な 24 桁の 16 進数のstring 。 |
JOB-ID | string | 必須 | ログをダウンロードするジョブの一意の識別子。 プロジェクトに関連付けられた JOB-IDsは、 1 つのプロジェクトのすべてのログ収集ジョブを取得するエンドポイントを使用して取得できます。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
このエンドポイントには、応答要素がありません。
リクエストの例
1 curl --user "{username}:{apiKey}" --digest 2 --header "Accept: application/json" 3 --header "Accept: application/gzip" 4 --output logs.tar.gz 5 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}/download"
注意
cURL を使用してリクエストを行う場合は、 --outputオプションを含め、ログを保存するファイル名を指定する必要があります。
応答例
応答ヘッダー
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}
レスポンス本体
このエンドポイントは、レスポンス本体を返しません。