転送ジョブ実行ログ取得

Prev Next
Get
/api/jobs/{job_id}/logs

転送ジョブを指定して実行ログを取得します。

ジョブのステータス確認には転送ジョブ実行結果取得をご利用ください。実行ログの取得はジョブの完了を検知した後に行うことを推奨します。

実行ログの仕様

  • 実行ログは約1年間保持されます。保持期間を過ぎた場合、logs.streams[].statusがexpiredとなります。
  • ジョブが完了しておらず実行ログがまだ出力されていない場合、logs.streams[].statusがpendingとなります。時間をおいて再度取得してください。
  • ログが一定の量を超える場合、先頭と末尾のみが取得され、中間はskipped...に置き換えられます。この場合logs.streams[].truncatedがtrueとなります。
  • logs.streams[].contentは改行を含む複数行のテキストです。
  • 実行中のジョブの場合、取得した時点でのログを返します。前回取得分からの差分を取得することはできません。

取得した実行ログの取り扱い

  • 実行ログには、接続先のホスト名やユーザー名、ファイルパス、実行したクエリ、エラーになったデータの値などが含まれる場合があります。
  • 接続情報に保存したパスワードやトークンを、TROCCOがログに書き出すことはありません。ただし、HTTP・HTTPS転送元で「マスキングする」を選んでいないパラメータ、クエリやカスタム変数に直接記載した値、接続先のサービスがエラーメッセージに含めた値は、そのまま含まれる場合があります。
  • 取得した内容を外部のAIサービスに渡す場合は、入力したデータが学習に使われない設定でご利用ください。あわせて、貴社のデータの取り扱い方針と、利用するAIサービスのデータの扱いを事前にご確認ください。
Security
API Key: ApiKeyAuth
Header parameter nameAuthorization

認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。

Path parameters
job_id
integer (int64) Required

転送ジョブIDを指定します。
TROCCO画面からIDを確認する場合は、API実行時に指定する各種パラメーターの確認方法を参照ください。

Example123
Query parameters
type
string

取得するログの種別を指定します。
未指定の場合、すべての種別のログを返します。

Valid values[ "log", "error_log" ]
Examplelog
Responses
200

転送ジョブの実行ログを返します。

Expand All
object
job
object
id
integer (int64)

転送ジョブIDです。

Example123
job_definition_id
integer (int64)

転送設定IDです。

Example321
status
string

転送ジョブのステータスです。

  • queued - 実行待機
  • setting_up - 実行準備
  • executing - 実行中
  • interrupting - 実行中断
  • succeeded - 実行完了(成功)
  • error - 実行完了(エラー)
  • canceled - 実行完了(キャンセル)
  • skipped - 実行完了(スキップ)
  • timeout - 実行完了(タイムアウト)
Valid values[ "queued", "setting_up", "executing", "interrupting", "succeeded", "error", "canceled", "skipped", "timeout" ]
Exampleerror
logs
object
streams
Array of object

種別ごとの実行ログです。typeを指定した場合、指定した種別のみを返します。(log, error_log の順)

object
type
string

ログの種別です。

  • log - 実行ログ
  • error_log - エラーログ
Valid values[ "log", "error_log" ]
Examplelog
status
string

この種別の実行ログの取得状態です。種別ごとに判定するため、typeでの絞り込みの有無によって値は変わりません。

  • available - 実行ログを取得できました
  • pending - ジョブが完了していないため、実行ログがまだ出力されていません。時間をおいて再度取得してください
  • empty - ジョブは完了しており、この種別の実行ログは出力されませんでした
  • expired - 保持期間を過ぎたため実行ログを取得できません

available以外の場合、contentは空文字を返します。

Valid values[ "available", "pending", "empty", "expired" ]
Exampleavailable
content
string

実行ログの本文です。改行を含む複数行のテキストです。
実行ログを取得できない場合、空文字を返します。

Example2023-05-19 19:15:00.000 +0000 [INFO]: Embulk started
truncated
boolean

実行ログの中間が省略されているかどうかです。
trueの場合、contentにskipped...が含まれます。

Examplefalse
byte_size
integer

contentのバイト数です。

Example1024
400

Bad request.
不正なリクエストです。

401

Not authenticated.
認証エラーです。API KEYをご確認ください。

403

Forbidden.
対象の転送設定を参照する権限がありません。

404

Not found.
要求したリソースが見つかりません。

503

Service unavailable.
実行ログの取得に失敗しました。時間をおいて再度お試しください。