---
title: "getWorkflow"
slug: "analytics-dataflow-getworkflowbyid"
updated: 2026-10-08T07:23:25Z
published: 2026-10-08T07:23:25Z
canonical: "api.ncloud-docs.com/analytics-dataflow-getworkflowbyid"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getWorkflow

VPC環境で利用できます。

ワークフローの詳細情報を照会します。

## リクエスト

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

| メソッド | URI |
| --- | --- |
| GET | /api/v1/workflows/{workflowId} |

### リクエストヘッダ

Data Flow APIで共通して使用されるヘッダの詳細は、[Data Flowのリクエストヘッダ](/docs/ja/analytics-dataflow#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `workflowId` | String | Required | ワークフロー ID - [getWorkflows](/docs/ja/analytics-dataflow-getworkflows)を参照 |

### リクエスト例

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

```
curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/workflows/3tfNLP******' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## レスポンス

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

### レスポンスボディ

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `workflowId` | String | - | ワークフロー ID |
| `name` | String | - | ワークフロー名 |
| `nodes` | Array | - | ノード情報: [nodes](/docs/ja/analytics-dataflow-getworkflowbyid#nodes) |
| `createdDate` | String | - | ワークフローの作成日時 - ISO 8601形式(UTC+9を含む) |
| `updatedDate` | String | - | ワークフローの更新日時 - ISO 8601形式(UTC+9を含む) |

#### `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.numWorker` | Integer | - | ワーカー数 - 2~10 |
| `jobCondition.timeout` | Integer | - | 実行タイムアウト(分) - 1~1440 |
| `jobCondition.nrn` | String | - | ジョブに対する NAVERクラウドプラットフォームリソースの識別値 |
| `jobCondition.scriptPath` | String | - | ジョブ実行スクリプトの保存先パス |
| `jobCondition.logPath` | String | - | ジョブの実行履歴の保存先パス |

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

Data Flow APIで共通して使用されるレスポンスステータスコードの詳細は、[Data Flowのレスポンスステータスコード](/docs/ja/analytics-dataflow#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
  "workflowId": "3tfNLP******",
  "name": "workflow001",
  "nodes": [
    {
      "id": "gqigvHhTu7ra",
      "name": "job001",
      "type": "JOB",
      "parentNodeIds": [
        "8bjF7E******"
      ],
      "isValid": true,
      "jobCondition": {
        "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"
    }
  ],
  "createdDate": "2025-03-24T14:46:24+09:00",
  "updatedDate": "2025-03-24T14:46:24+09:00"
}
```