Press CTRL+K to open search

dbtジョブ実行結果取得

Prev Next
Get
/api/dbt_jobs/{dbt_job_id}

dbtジョブを指定してdbtジョブの実行結果を取得します。
実行されたdbtコマンドやモデル単位の実行結果は、本APIのレスポンスには含まれません。dbtジョブの実行ログを参照ください。
dbtジョブ設定の内容はdbtジョブ設定詳細取得で取得できます。

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
dbt_job_id
integer (int64) Required

dbtジョブIDを指定します。
TROCCO画面からIDを確認する場合は、dbtジョブ詳細画面のURL末尾の数値を参照ください。

Example123
Responses
200

dbtジョブの実行結果を返します。

object
id
integer (int64)

dbtジョブIDです。

Example123
dbt_job_definition_id
integer (int64)

dbtジョブ設定IDです。

Example45
dbt_job_definition_name
string

dbtジョブ設定名です。

Examplesample-dbt-job-definition-name
dbt_job_definition_revision_id
integer (int64) | null

dbtジョブの実行時に使用されたdbtジョブ設定のリビジョンIDです。
リビジョン単体を取得するAPIはありません。複数のdbtジョブ間で値を比較することで、dbtジョブ設定が変更されたかどうかを判別するための識別子です。

Example678
status
string

dbtジョブのステータスです。

  • queued - 実行待機
  • setting_up - 実行準備
  • executing - 実行中
  • interrupting - 実行中断
  • succeeded - 実行完了（成功）
  • error - 実行完了（エラー）
  • canceled - 実行完了（キャンセル）
  • skipped - 実行完了（スキップ）
Valid values[ "queued", "setting_up", "executing", "interrupting", "succeeded", "error", "canceled", "skipped" ]
Examplesucceeded
executor_type
string

dbtジョブの実行経路です。

  • manual - 手動実行
  • scheduler - スケジュール実行
  • workflow - ワークフロー経由の実行
Valid values[ "manual", "scheduler", "workflow" ]
Exampleworkflow
context_time
string

カスタム変数の展開基準となる日時です。手動実行ではdbtジョブの作成日時、ワークフロー経由の実行ではワークフロージョブの基準日時です。
タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:00:00.000+09:00
started_at
string | null

dbtジョブのステータスが実行中になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:15:00.000+09:00
finished_at
string | null

dbtジョブのステータスが実行完了になった日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:20:00.000+09:00
created_at
string

dbtジョブの作成日時です。タイムゾーンはJST 日本時間（GMT+9）です。

Example2023-05-19T19:14:00.000+09:00
400

/api系の共通エラーレスポンス

Expand All
object
message
string
Example不正なリクエストです。
errors
Array of object

400エラー時のみ含まれる。エラーの詳細。

object
attribute
string

属性名

message
string

エラーメッセージ

401

認証エラー

object
message
string
Exampleアカウント登録もしくはログインしてください。
403

Forbidden.
API KEYが不正か、dbtジョブを利用できないアカウントです。

404

Not found.
指定したdbtジョブが存在しません。