FlowSpec で定義されたワークフローノードとその内部の子ノードを DataStudio にインポートします。
操作説明
-
この操作では、複数のワークフローのインポートはサポートされていません。FlowSpec に複数のワークフローが定義されている場合、最初のワークフロー以降はすべて無視されます。
-
これは非同期操作です。この操作を呼び出すと、非同期タスクオブジェクトが返されます。タスクの実行ステータスをクエリするには、GetJobStatus を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dataworks:* |
update |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectId |
integer |
必須 |
DataWorks ワークスペースの ID。DataWorks コンソール にログインし、ワークスペース管理ページに移動して ID を取得できます。 このパラメーターは、この API の呼び出しに使用される DataWorks ワークスペースを指定します。 |
123456 |
| Spec |
string |
必須 |
ワークフローを記述する FlowSpec 情報。仕様の詳細については、「 FlowSpec 」をご参照ください。 説明
FlowSpec テンプレートをすばやく取得する方法
重要 この操作では、ワークフローとその内部ノードを同時に作成できます。FlowSpec で指定された ID にアテンションを払ってください。指定された ID が既に存在する場合、操作は更新になります。ID が指定されていないか、ID が存在しない場合にのみ、操作は作成になります。 |
{ "version": "1.1.0", "kind": "CycleWorkflow", "spec": { "name": "非同期_ワークフロー_作成_テスト", "id": "632647691239009XXXX", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test", "runtime": { "command": "WORKFLOW" } }, "id": "632647691239009XXXX", "trigger": { "type": "Scheduler", "cron": "00 03 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "strategy": { "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "failureStrategy": "Break" }, "name": "非同期_ワークフロー_作成_テスト", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "632647691239009XXXX", "artifactType": "NodeOutput", "refTableName": "非同期_ワークフロー_作成_テスト" } ] }, "nodes": [ { "recurrence": "Normal", "id": "742981001612325XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n" }, "trigger": { "type": "Scheduler", "cron": "00 24 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "111", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "742981001612325XXXX", "artifactType": "NodeOutput", "refTableName": "111" } ] } }, { "recurrence": "Normal", "id": "595182137303408XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "script": { "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222", "runtime": { "command": "ODPS_SQL" }, "content": "select now();\n select 1;" }, "trigger": { "type": "Scheduler", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "name": "222", "inputs": {}, "outputs": { "nodeOutputs": [ { "data": "595182137303408XXXX", "artifactType": "NodeOutput", "refTableName": "222" } ] } } ], "dependencies": [ { "nodeId": "595182137303408XXXX", "depends": [ { "type": "Normal", "output": "742981001612325XXXX", "refTableName": "111" } ] } ] } ] } } |
| DryRun |
boolean |
任意 |
この操作を検証モードで呼び出すかどうかを指定します。このパラメーターが true にセットされている場合、入力されたワークフロー仕様の有効性のみが検証されます。実際のインポートと同じ前処理および検証ロジックが再利用されます（ルールも同一）が、データの永続化や書き込み操作は実行されません。検証結果は非同期タスクを通じて返されます。検証に失敗した場合、非同期タスクは失敗し、エラーの詳細にはエラーコード、エラーメッセージ、および特定のノードの位置を示す JSONPath（例: $.spec.workflows[0].nodes[1]）が含まれます。ログは記録されません。 デフォルト値: false。この場合、ワークフローは通常どおりインポートされます。 |
false。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| RequestId |
string |
リクエスト ID。この ID を使用して問題のトラブルシューティングを行えます。 |
7C352CB7-CD88-50CF-9D0D-E81BDF020E7F。 |
| AsyncJob |
object |
非同期タスクのステータス情報。 |
|
| Completed |
boolean |
非同期タスクが完了したかどうかを示します。 |
false。 |
| CreateTime |
integer |
非同期タスクが作成されたタイムスタンプ。 |
1706581425000 |
| Error |
string |
非同期タスクが失敗した場合のエラーメッセージ。 |
target folder already exists: XXXX。 |
| Id |
string |
非同期タスクの ID。 |
1234567691239009XXXX。 |
| Progress |
integer |
非同期タスクの進捗状況。有効な値: 0～100。 |
0 |
| Response |
string |
非同期タスクが返すと予想されるコンテンツ。 説明
このフィールドには現在、非同期タスクで作成されたワークフローの ID が格納されています。 |
632647691239009XXXX。 |
| Status |
string |
非同期タスクのステータス。 有効な値:
|
Running。 |
| Type |
string |
非同期タスクの操作タイプ。 有効な値:
|
Create。 |
例
成功レスポンス
JSONJSON
{
"RequestId": "7C352CB7-CD88-50CF-9D0D-E81BDF020E7F",
"AsyncJob": {
"Completed": false,
"CreateTime": 1706581425000,
"Error": "target folder already exists: XXXX",
"Id": "1234567691239009XXXX",
"Progress": 0,
"Response": "632647691239009XXXX",
"Status": "Running",
"Type": "Create"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。