getJobExecutions

Prev Next

VPC環境で利用できます。

ジョブの実行リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/jobs/{jobId}/executions

リクエストヘッダ

Data Flow APIで共通して使用されるヘッダの詳細は、Data Flowのリクエストヘッダをご参照ください。

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

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
jobId String Required ジョブ ID

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

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
page Integer Optional ページ番号
  • 0~N (デフォルト: 0)
limit Integer Optional ページの出力数
  • 0~N (デフォルト: 1000)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/jobs/gqigvH******/executions?page=0&limit=4' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
list Array - ジョブ実行リスト
count Integer - レスポンス結果数
page Integer - ページ番号
limit Integer - ページ表示数

list

listの説明は次の通りです。

フィールド タイプ 必須の有無 説明
jobExecutionId String - ジョブの実行 ID
jobId String - ジョブ ID
jobCondition Object - ジョブ実行オプション情報
jobCondition.workerType String - ワーカータイプ
  • DATAFLOW(デフォルト)
jobCondition.numWorker Integer - ワーカー数
  • 2 (デフォルト)
jobCondition.timeout Integer - 実行タイムアウト(分)
  • ジョブを1回実行するにあたって結果を待つ時間
  • ~1440 (デフォルト: 360)
jobCondition.nrn String - ジョブに対する NAVERクラウドプラットフォームリソースの識別値
jobCondition.scriptPath String - ジョブ実行スクリプトの保存パス
jobCondition.logPath String - ジョブの実行履歴の保存パス
status String - ジョブの最終実行状態
  • READY | RUNNING | COMPLETED | FAILED | CANCELED
    • READY: 待機中
    • RUNNING: 実行中
    • COMPLETED: 完了
    • FAILED: 失敗
    • CANCELED: キャンセル
startDate String - ジョブの実行日時
  • ISO 8601形式(UTC+9を含む)
endDate String - ジョブの終了日時
  • ISO 8601形式(UTC+9を含む)
createdDate String - ジョブの作成日時
  • ISO 8601形式(UTC+9を含む)
triggerId String - トリガー ID
jobName String - ジョブ名
waitingTime Integer - ジョブ待機時間(分)
executorNum Integer - ジョブワーカー数
runningTime Integer - ジョブの実行時間(分)
parsedParameters Object - パースされたジョブ実行パラメータ
type String - ジョブタイプ
  • JOB | WORKFLOW

レスポンスステータスコード

Data Flow APIで共通して使用されるレスポンスステータスコードの詳細は、Data Flow APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "list": [
        {
            "jobExecutionId": "fKE22JFX4PAu",
            "jobId": "gqigvHhTu7ra",
            "jobCondition": {
                "workerType": "DEFAULT",
                "numWorker": 2,
                "timeout": 360,
                "nrn": "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
                "scriptPath": "dataflow-2706412-****/scripts/",
                "logPath": "dataflow-2706412-****/sparkHistoryLogs/",
                "consoleLogPath": "dataflow-2706412-****/sparkHistoryLogs/console/gqigvHhTu7ra/fKE22JFX4PAu_2025-03-21T11:12:56.log"
            },
            "status": "COMPLETED",
            "startDate": "2025-03-21T11:12:54+09:00",
            "endDate": "2025-03-21T11:27:47+09:00",
            "createdDate": "2025-03-21T11:12:54+09:00",
            "triggerId": "8bjF7EjNypqG",
            "triggerName": "trigger002",
            "jobName": "job001",
            "waitingTime": 830,
            "executorNum": 2,
            "runningTime": 14,
            "parsedParameters": [],
            "type": "WORKFLOW"
        }
    ],
    "count": 1,
    "page": 0,
    "limit": 1000
}