getJobs

VPC環境で利用できます。

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

リクエスト

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

メソッド	URI
GET	/api/v1/jobs

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`name`	String	Optional	ジョブ名
`status`	String	Optional	ジョブの状態 `RUNNABLE` \| `RUNNING` \| `DELETED` \| `UNKNOWN` \| `DRAFT` \| `STOPPED` \| `EDITING` `RUNNABLE`: ジョブ実行可能 `RUNNING`: ジョブ実行中 `DELETED`: ジョブを削除中または削除完了 `UNKNOWN`: その他 `DRAFT`: ジョブの編集が完了していない `STOPPED`: ジョブを停止中 `EDITING`: ジョブを編集中(有効性検証が必要)
`page`	Integer	Optional	ページ番号 0~N (デフォルト: 0)
`limit`	Integer	Optional	ページの出力数 0~N (デフォルト: 1000)

リクエスト例

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

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/jobs?page=0&limit=1000' \
--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の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`jobId`	String	-	ジョブ ID
`name`	String	-	ジョブ名
`type`	String	-	ジョブのタイプ `DATAFLOW` (デフォルト)
`status`	String	-	ジョブの状態 `RUNNABLE` \| `RUNNING` \| `DELETED`\| `DRAFT` \| `EDITING`\| `STOPPED` `RUNNABLE`: 実行可能 `RUNNING`: 実行中 `DELETED`: 削除中または削除完了 `DRAFT`: 編集が完了していない `EDITING`: 編集中(有効性検証が必要) `STOPPED`: 停止中または停止完了
`lastExecutionStatus`	String	-	ジョブの最終実行状態 `COMPLETED` \| `FAILED` \| `CANCELED` `COMPLETED`: 完了 `FAILED`: 失敗 `CANCELED`: キャンセル
`createdDate`	String	-	ジョブの作成日時 ISO 8601形式(UTC+9を含む)
`updatedDate`	String	-	ジョブの更新日時 ISO 8601形式(UTC+9を含む)
`lastExecutionDate`	String	-	ジョブの最終実行日時 ISO 8601形式(UTC+9を含む)
`resourceId`	String	-	リソース ID ジョブ ID(`jobId`)と同じ
`disabled`	Boolean	-	リソース照会権限はあるかどうか

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

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

レスポンス例

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

{
    "list": [
        {
            "jobId": "fAjvc*******",
            "name": "job002",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-20T08:54:03+09:00",
            "updatedDate": "2025-03-20T14:01:23+09:00",
            "lastExecutionDate": "2025-03-20T14:00:09+09:00",
            "resourceId": "fAjvc*******",
            "disabled": false
        },
        {
            "jobId": "gqigvH******",
            "name": "job001",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-19T15:03:42+09:00",
            "updatedDate": "2025-03-20T13:07:34+09:00",
            "lastExecutionDate": "2025-03-20T13:06:05+09:00",
            "resourceId": "gqigvH******",
            "disabled": false
        }
    ],
    "count": 2,
    "page": 0,
    "limit": 1000
}