getWorkflows

VPC環境で利用できます。

ワークフローリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/workflows?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の説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workflowId`	String	-	ワークフロー ID
`name`	String	-	ワークフロー名
`createdDate`	String	-	ワークフローの作成日時 ISO 8601形式(UTC+9を含む)
`updatedDate`	String	-	ワークフローの更新日時 ISO 8601形式(UTC+9を含む)
`lastExecutionDate`	String	-	ワークフローの最終実行日時 ISO 8601形式(UTC+9を含む)
`isTemp`	Boolean	-	一時保存かどうか `true` \| `false` `true`: 一時保存 `false`: 即完了(一時保存しない)
`triggerRuleType`	String	-	トリガーの実行オプションタイプ `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`nodes`	Array	-	ノード情報
`resourceId`	String	-	リソース ID ワークフロー IDと同じ
`disabled`	Boolean	-	リソース照会権限があるかどうか

`nodes`

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	ノード ID `type`に応じて`triggerId`または`jobId`値を表示
`name`	String	-	ノード名 `type`に応じてトリガー名またはジョブ名を表示
`type`	String	-	ノードタイプ `TRIGGER` \| `JOB`
`parentNodeIds`	Array	-	上位ノード IDリストジョブノードオブジェクトはトリガーノードの IDを表示トリガーノードオブジェクトは空の値を表示
`triggerRule`	String	-	トリガーノードの実行オプション情報 `RECURRING` \| `ONE_TIME` \| `NONE` `RECURRING`: 周期実行 `ONE_TIME`: 特定日実行 `NONE`: 実行オプションなし
`isValid`	Boolean	-	ノードは削除されたか(ノードは使用可能か) `true` \| `false` `true`: 削除されていない(使用可能) `false`: 削除(使用不可)
`jobCondition`	Object	-	ジョブ実行オプション情報
`jobCondition.workerType`	String	-	ワーカータイプ `DATAFLOW`(デフォルト)
`jobCondition.numWorker`	Integer	-	ワーカー数 2 (デフォルト)
`jobCondition.timeout`	Integer	-	実行タイムアウト(分) ジョブを1回実行するにあたって結果を待つ時間 0~1440 (デフォルト: 360)
`jobCondition.nrn`	String	-	ジョブに対する NAVERクラウドプラットフォームリソースの識別値
`jobCondition.scriptPath`	String	-	ジョブ実行スクリプトの保存パス
`jobCondition.logPath`	String	-	ジョブの実行履歴の保存パス

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

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

レスポンス例

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

{
  "list": [
    {
      "workflowId": "3tfNLP******",
      "name": "workflow001",
      "createdDate": "2025-03-24T14:46:24+09:00",
      "updatedDate": "2025-03-24T14:46:24+09:00",
      "isTemp": false,
      "triggerRuleType": "RECURRING",
      "nodes": [
        {
          "id": "gqigvH******",
          "name": "job001",
          "type": "JOB",
          "parentNodeIds": [
            "8bjF7E******"
          ],
          "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 3,
            "timeout": 360,
            "nrn": "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
            "scriptPath": "dataflow-2706412-****/scripts/",
            "logPath": "dataflow-2706412-****/sparkHistoryLogs/"
          }
        },
        {
          "id": "8bjF7E******",
          "name": "trigger001",
          "type": "TRIGGER",
          "parentNodeIds": [],
          "triggerRule": "RECURRING"
        }
      ],
      "resourceId": "3tfNLP******",
      "disabled": false
    }
  ],
  "count": 1,
  "page": 0,
  "limit": 1000
}