UpdateWorkflow API でワークフロー更新を自動化 - DataWorks - Alibaba Cloud -

フルアップデートメソッドを使用して、指定されたワークフローを更新します。DataStudio に同期して更新できるフィールドには、オーナー、データソース、スケジュールリソースグループ、説明、およびトリガー実行モード（Normal、Skip、または Pause）が含まれます。

操作説明

DataWorks Basic Edition 以上のエディションが必須です。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	ワークフローの ID。	1234
EnvType	string	任意	プロジェクト環境。有効な値: Prod: 本番環境 Dev: 開発環境	Prod
Name	string	必須	名前。	My Workflow
Owner	string	必須	オーナーのアカウント ID。	1000
Trigger	object	必須	トリガー構成。
Type	string	必須	トリガータイプ。有効な値: Scheduler: スケジューリング周期によるトリガー Manual: 手動トリガー	Scheduler
Cron	string	任意	cron 式。このパラメーターは、type が Scheduler にセットされている場合にのみ効果が適用されます。	00 00 00 * * ?
StartTime	string	任意	エポックトリガーの有効期間。このパラメーターは、type が Scheduler にセットされている場合にのみ効果が適用されます。フォーマット: `yyyy-mm-dd hh:mm:ss`。	1970-01-01 00:00:00
EndTime	string	任意	定期トリガーの有効期限となる期間。このパラメーターは、type が Scheduler にセットされている場合にのみ効果が適用されます。フォーマット: `yyyy-mm-dd hh:mm:ss`。	9999-01-01 00:00:00
Description	string	任意	説明。	test
Dependencies	array<object>	任意	依存関係情報。
	object	任意
Type	string	必須	依存関係タイプ。有効な値: CrossCycleDependsOnChildren: 第 1 レベルの子ノードに対するクロスサイクル依存関係 CrossCycleDependsOnSelf: 現在のノードに対するクロスサイクル依存関係 CrossCycleDependsOnOtherNode: 他のノードに対するクロスサイクル依存関係 Normal: 同サイクル依存関係	Normal
UpstreamOutput	string	任意	上流ノードの出力識別子。このフィールドは、依存関係タイプが `same-cycle dependency` で、かつ入力コンテンツが指定されている場合に返されます。	pre.odps_sql_demo_0
UpstreamTaskId	integer	任意	上流ノードの ID。このフィールドは、依存関係タイプが `cross-cycle dependency on other nodes` または入力コンテンツが指定されていない `same-cycle dependency` の場合に返されます。それ以外の場合は返されません。	1234
Parameters	string	任意	パラメーターリスト。	para1=$bizdate para2=$[yyyymmdd]
Tasks	array<object>	任意	ノードリスト。
	array<object>	任意
Id	integer	任意	ノードの ID。このフィールドを指定すると、対応するノードがフルアップデートされます。このフィールドを指定しない場合、新しいノードが作成されます。	1234
Name	string	必須	ノードの名前。	SQL node
Description	string	任意	説明。	Test
Type	string	必須	ノードタイプ。	ODPS_SQL
Owner	string	必須	オーナーのアカウント ID。	1000
BaseLineId	integer	任意	ベースラインの ID。	1234
Timeout	integer	任意	ノード実行のタイムアウト期間（秒単位）。	3600
RerunMode	string	必須	ノードを再実行できるかどうかを指定します。有効な値: AllDenied: 成否に関係なく再実行不可 FailureAllowed: 失敗時のみ再実行可能 AllAllowed: 成否に関係なく再実行可能	AllAllowed
RerunTimes	integer	任意	リトライ回数。このパラメーターは、ノードが再実行を許可するように構成されている場合にのみ効果が適用されます。	3
RerunInterval	integer	任意	リトライ時間間隔（秒単位）。	60
Script	object	任意	スクリプト情報。
Content	string	任意	スクリプトの内容。	echo "helloWorld"
Parameters	string	任意	スクリプトパラメーターのリスト。	para1=$bizdate
Trigger	object	必須	ノードのトリガー構成。
Type	string	任意	トリガータイプ。有効な値: Scheduler: スケジューリング周期によるトリガー Manual: 手動トリガー	Scheduler
Recurrence	string	必須	トリガー時の実行モード。このパラメーターは、type が Scheduler にセットされている場合にのみ効果が適用されます。有効な値: Pause: 一時停止 Skip: ドライラン Normal: 通常実行	Normal
RuntimeResource	object	必須	リソースグループ情報などの実行環境構成。
ResourceGroupId	string	必須	ノードに設定されたスケジュールリソースグループの識別子。	S_res_group_524258031846018_1684XXXXXXXXX
Image	string	任意	ノードに設定されたイメージの ID。	i-xxxxxx
Cu	string	任意	ノードに設定された CU 消費量。	0.25
DataSource	object	任意	関連付けられたデータソース情報。
Name	string	任意	データソース名。	odps_test
Inputs	object	任意	入力情報。このフィールドが空の場合、デフォルトで全ての Inputs 構成が削除されます。
Variables	array<object>	任意	変数定義のリスト。このフィールドが指定されていないか、または空の配列である場合、デフォルトで全ての Inputs.Variables 構成が削除されます。
	object	任意
Name	string	任意	変数の名前です。	key1
Type	string	必須	種類です。有効な値は以下のとおりです。 Constant：定数値 PassThrough：ノード出力 System：システム変数 NodeOutput：スクリプト出力	Constant
Value	string	任意	変数の値です。	value1
Outputs	object	任意	出力情報。このフィールドが空の場合、デフォルトで全ての Outputs 構成が削除されます。
TaskOutputs	array<object>	任意	ノード出力定義のリスト。このフィールドが指定されていないか、または空の配列である場合、デフォルトで全ての TaskOutputs 構成が削除されます。
	object	任意
Output	string	任意	出力の識別子です。	pre.odps_sql_demo_0
Variables	array<object>	任意	変数定義のリスト。このフィールドが指定されていないか、または空の配列である場合、デフォルトで全ての Outputs.Variables 構成が削除されます。
	object	任意
Name	string	任意	変数の名前です。	key1
Type	string	必須	種類です。有効な値は以下のとおりです。 Constant：定数値 PassThrough：ノード出力 System：システム変数 NodeOutput：スクリプト出力	Constant
Value	string	任意	変数の値です。	value1
Dependencies	array<object>	任意	依存関係情報。このフィールドが指定されていないか、または空の配列である場合、デフォルトで全ての Dependencies 構成が削除されます。
	object	任意
Type	string	必須	依存関係タイプ。有効な値: CrossCycleDependsOnChildren: 第 1 レベルの子ノードに対するクロスサイクル依存関係 CrossCycleDependsOnSelf: 現在のノードに対するクロスサイクル依存関係 CrossCycleDependsOnOtherNode: 他のノードに対するクロスサイクル依存関係 Normal: 同サイクル依存関係	Normal
UpstreamOutput	string	任意	上流ノードの出力識別子。このフィールドは、依存関係タイプが `same-cycle dependency` で、かつ入力コンテンツが指定されている場合に返されます。	pre.odps_sql_demo_0
UpstreamTaskId	integer	任意	上流ノードの ID。このフィールドは、依存関係タイプが `cross-cycle dependency on other nodes` または入力コンテンツが指定されていない `same-cycle dependency` の場合に返されます。それ以外の場合は返されません。	1234
Tags	array<object>	任意	ノードタグのリスト。このフィールドが指定されていないか、または空の配列である場合、デフォルトで全ての Tags 構成が削除されます。
	object	任意
Key	string	必須	タグキー。	key1
Value	string	任意	タグ値。	value1
ClientUniqueCode	string	任意	非同期操作およびべき等性に使用されるノードのクライアント固有コード。作成時に指定しない場合、システムによって自動的に生成され、コードはリソース ID に一意にバインドされます。更新または削除時にこのパラメーターを指定する場合、作成時に使用したクライアント固有コードと一致している必要があります。	Task_0bc5213917368545132902xxxxxxxx
EnvType	string	任意	プロジェクト環境。有効な値: Prod: 本番環境 Dev: 開発環境	Prod
Outputs	object	任意	出力情報。
TaskOutputs	array<object>	任意	ワークフローノード出力定義のリスト。
	object	任意
Output	string	任意	出力識別子。	pre.odps_sql_demo_0
Tags	array<object>	任意	ワークフロータグのリスト。
	object	任意
Key	string	必須	タグキー。	key1
Value	string	任意	タグ値。	value1
ClientUniqueCode	string	任意	非同期操作およびべき等性に使用されるワークフローのクライアント固有コード。作成時に指定しない場合、システムによって自動的に生成され、コードはリソース ID に一意にバインドされます。更新または削除時にこのパラメーターを指定する場合、作成時に使用したクライアント固有コードと一致している必要があります。	Workflow_0bc5213917368545132902xxxxxxxx
InstanceMode	string	任意	インスタンス生成モード。有効な値: T+1: インスタンスは翌日に生成されます。 Immediately: インスタンスは直ちに生成されます。定期インスタンスは、ワークフローの公開から少なくとも 10 分後にワークフローのスケジュール時刻が設定されている場合にのみ生成されます。全インスタンス生成時間（22:00～24:00）中は、リアルタイムインスタンス生成を利用できません。この期間中にワークフローを送信および公開することはできますが、送信後にインスタンスは再生成されません。	T+1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	ログの特定および問題のトラブルシューティングに使用されるリクエスト ID。	22C97E95-F023-56B5-8852-B1A77A17XXXX
Success	boolean	操作が成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "Success": true
}

エラーコード

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

変更履歴

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