createWorkflow
- 印刷する
- PDF
createWorkflow
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
ワークフローを作成します。
POST https://dataflow.apigw.ntruss.com/api/v1/workflows
リクエスト
リクエストボディ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| name | Yes | String | - 先頭文字は英字まはたアンダースコア「」 - 英数字、アンダースコア「」、ハイフン「-」を使用可能 - 3~20文字以内で入力 | ジョブ名 |
| nodes[].id | Yes | String | ノード ID | |
| nodes[].name | Yes | String | ノード名 | |
| nodes[].type | Yes | String | TRIGGER, JOB | ノードタイプ |
| nodes[].parentNodeIds | Yes | String | 上位ノード ID | |
| nodes[].triggerRule | No | String | トリガーノードオプション | |
| nodes[].jobCondition | Object | ジョブ実行オプション |
レスポンス
| フィールド名 | タイプ | 説明 | 備考 |
|---|---|---|---|
| workflowId | String | ワークフロー ID | |
| name | String | ワークフロー名 | |
| nodes[].id | String | ノード ID | |
| nodes[].name | String | ノード名 | |
| nodes[].type | String | ノードタイプ | |
| nodes[].parentNodeIds | String | 上位ノード ID | |
| nodes[].triggerRule | String | トリガーノードオプション | |
| nodes[].jobCondition | Object | ジョブ実行オプション | |
| nodes[].isValid | Boolean | 削除の有無 | |
| createdDate | String | ジョブ作成日 | |
| updatedDate | String | 最終アップデート | |
| isTemp | Boolean | 下書き保存するかどうか |
レスポンスステータス
| HTTP Status | Desc |
|---|---|
| 201 | Created(作成完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
例
リクエスト例
POST /api/v1/workflows
Host: dataflow.apigw.ntruss.com
x-ncp-iam-access-key: {Access key}
x-ncp-apigw-signature-v2: {API GW signature}
x-ncp-apigw-timestamp: {timestamp}
{
"isTemp": false,
"name": "test-workflow2",
"nodes": [
{
"id": "RpiB7okASK5W",
"name": "cdb_pg_test",
"type": "JOB",
"parentNodeIds": [
"vMcf5Gvf2x3R"
],
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 3,
"timeout": 360,
"nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
"scriptPath": "dataflow-33-****/scripts/",
"logPath": "dataflow-33-****/sparkHistoryLogs/"
}
},
{
"id": "vMcf5Gvf2x3R",
"name": "awefawef",
"type": "TRIGGER",
"parentNodeIds": [],
"triggerRule": "NONE"
}
]
}
レスポンス例
{
"workflowId": "pJ1HCEI7L9ha",
"name": "test-workflow2",
"nodes": [
{
"id": "RpiB7okASK5W",
"name": "cdb_pg_test",
"type": "JOB",
"parentNodeIds": [
"vMcf5Gvf2x3R"
],
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 3,
"timeout": 360,
"nrn": "nrn:PUB:IAM::25****4:Role/****-a9d6-****-a85d-****",
"scriptPath": "dataflow-33-****/scripts/",
"logPath": "dataflow-33-****/sparkHistoryLogs/"
}
},
{
"id": "vMcf5Gvf2x3R",
"name": "awefawef",
"type": "TRIGGER",
"parentNodeIds": [],
"triggerRule": "NONE"
}
],
"createdDate": "2024-07-10T14:16:01+09:00",
"updatedDate": "2024-07-10T14:16:01+09:00",
"isTemp": false
}
この記事は役に立ちましたか?