getJobExecutions

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

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

`list`

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

フィールド	タイプ	必須の有無	説明
`jobExecutionId`	String	-	ジョブの実行 ID
`jobId`	String	-	ジョブ ID
`jobCondition`	Object	-	ジョブ実行オプション情報
`jobCondition.numWorker`	Integer	-	ワーカー数 2~10
`jobCondition.timeout`	Integer	-	実行タイムアウト(分) 1~1440
`jobCondition.nrn`	String	-	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	-	ジョブ実行スクリプトの保存先パス
`jobCondition.logPath`	String	-	ジョブの実行履歴の保存先パス
`jobCondition.consoleLogPath`	String	-	ジョブ実行コンソールログの保存先パス実行終了後に含まれる
`jobCondition.parameters`	Object	-	実行に適用されたジョブパラメータキー・値形式の文字列マップ
`status`	String	-	ジョブ実行の状態 `READY` \| `RUNNING` \| `COMPLETED` \| `FAILED` \| `CANCELLING` \| `CANCELLED` \| `TIMEOUT` `READY`: 実行待機 `RUNNING`: 実行中 `COMPLETED`: 完了 `FAILED`: 失敗 `CANCELLING`: キャンセル処理中 `CANCELLED`: キャンセル済み `TIMEOUT`: 実行制限時間超過
`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	-	ジョブ実行時間(秒) 実行終了前は`0`
`type`	String	-	ジョブタイプ `JOB` \| `WORKFLOW`

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

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

レスポンス例

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

{
    "list": [
        {
            "jobExecutionId": "fKE22J******",
            "jobId": "5Yns7J******",
            "jobCondition": {
                "numWorker": 2,
                "timeout": 360,
                "nrn": "nrn:PUB:IAM::*******:Role/********",
                "scriptPath": "dataflow-2706412-****/scripts/",
                "logPath": "dataflow-2706412-****/sparkHistoryLogs/",
                "consoleLogPath": "dataflow-2706412-****/sparkHistoryLogs/console/5Yns7J******/fKE22J******_2025-03-21T11:12:56.log",
                "parameters": {
                    "target_date": "2025-03-21",
                    "input_path": "aitems/sales/",
                    "output_format": "parquet"
                }
            },
            "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": "8bjF7E******",
            "triggerName": "trigger002",
            "jobName": "daily_sales_job",
            "waitingTime": 830,
            "executorNum": 2,
            "runningTime": 14,
            "type": "WORKFLOW"
        }
    ],
    "count": 1,
    "page": 0,
    "limit": 4
}