DataWorks API で DataStudio ワークフロー作成を自動化 - DataWorks - Alibaba Cloud - DataWorks

操作説明

重要この操作はバッチ操作をサポートしていません。FlowSpec に複数のワークフローが定義されている場合、最初のワークフローを除くすべてのワークフローは無視されます。さらに、ワークフロー内で定義されたノードも無視されます。内部ノードを作成するには、CreateNode 操作を呼び出して 1 つずつ作成してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	DataWorks ワークスペースの ID。DataWorks コンソールにログインし、ワークスペース設定ページに移動してワークスペース ID を取得できます。	10000
Spec	string	必須	ワークフローを記述する FlowSpec 情報。仕様の詳細については、「 FlowSpec 」を参照してください。説明 FlowSpec テンプレートをすばやく取得する方法 DataStudio でワークフローを開き、右上隅の「Show Spec」をクリックすると、現在のワークフローの FlowSpec 記述を取得できます。この FlowSpec 記述を使用して、要件を満たすテンプレートをすばやく構築できます。重要この操作はワークフローの作成のみをサポートしています。FlowSpec に記述された内部ノードは作成されません。	{ "kind": "CycleWorkflow", "version": "1.1.0", "spec": { "name": "OpenAPITestWorkflowDemo", "type": "CycleWorkflow", "workflows": [ { "script": { "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo", "runtime": { "command": "WORKFLOW" } }, "trigger": { "type": "Scheduler", "cron": "00 02 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": "OpenAPITestWorkflowDemo", "outputs": { "nodeOutputs": [ { "data": "workflow_output", "artifactType": "NodeOutput", "refTableName": "OpenAPITestWorkflowDemo" } ] }, "dependencies": [] } ] } }

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用されます。	0EF298E5-0940-5AC7-9CB0-6502507****
Id	string	DataStudio ワークフローの一意識別子。重要このフィールドは、8.0.0 より前の SDK バージョンでは Long 型でしたが、SDK 8.0.0 以降では String 型になっています。この変更は通常の SDK の使用量に影響を与えず、パラメーターは引き続き SDK で定義された型で返されます。SDK バージョン 8.0.0 をまたいでスペックアップする場合にのみ、型の変更によりプロジェクトのコンパイルエラーが発生する可能性があり、データの型を手動で修正する必要があります。	463497880880954XXXX

例

成功レスポンス

JSONJSON

{
  "RequestId": "0EF298E5-0940-5AC7-9CB0-6502507****",
  "Id": "463497880880954XXXX"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。