API によるデータバックフィルのためのワークフローインスタンス作成 - DataWorks

構成に基づき、データバックフィルワークフローインスタンスなどのワークフローインスタンスを作成します。

操作説明

DataWorks のベーシック版以上をご購入いただく必要があります。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	必須	プロジェクト ID。	100
EnvType	string	任意	プロジェクトの環境。有効な値： Prod Dev	Prod
WorkflowId	integer	必須	インスタンスが属するワークフローの ID。定期タスクの場合、このパラメーターは 1 に設定されます。	1
Name	string	必須	名前。	WorkflowInstance1
Periods	object	任意	データバックフィル期間の構成。
BizDates	array<object>	必須	データタイムスタンプ。最大 7 個のデータタイムスタンプを指定できます。
	object	任意
StartBizDate	string	必須	データバックフィルを開始するデータタイムスタンプ。このパラメーターは `yyyy-mm-dd` 形式で設定してください。	2024-11-20
EndBizDate	string	必須	データバックフィルを終了するデータタイムスタンプ。このパラメーターは `yyyy-mm-dd` 形式で設定してください。	2024-11-24
StartTime	string	任意	データバックフィルの開始時刻。このパラメーターは `hh:mm:ss` 形式（24 時間表記）で設定してください。デフォルト値：00:00:00。このパラメーターを設定する場合は、EndTime パラメーターも併せて設定する必要があります。	00:00:00
EndTime	string	任意	データバックフィルの終了時刻。このパラメーターは `hh:mm:ss` 形式（24 時間表記）で設定してください。デフォルト値：23:59:59。このパラメーターを設定する場合は、StartTime パラメーターも併せて設定する必要があります。	23:59:59
Type	string	必須	ワークフローインスタンスの種類。有効な値： SupplementData：データバックフィル。RootTaskIds および IncludeTaskIds の使用方法は、バックフィルモードによって異なります。「DefaultRunProperties.Mode」パラメーターの説明をご参照ください。 ManualWorkflow：手動実行型ワークフロー。手動実行型ワークフローでは WorkflowId の指定が必須です。RootTaskIds は任意指定です。未指定の場合は、手動実行型ワークフローのデフォルトルートタスク一覧が使用されます。 Manual：手動タスク。RootTaskIds のみを指定します。これは実行対象の手動タスクの一覧です。 SmokeTest：スモークテスト。RootTaskIds のみを指定します。これは実行対象のテストタスクの一覧です。 TriggerWorkflow：トリガー型ワークフロー。トリガーされるワークフローの WorkflowId を指定する必要があります。IncludeTaskIds は任意指定です。未指定の場合は、ワークフロー全体が実行されます。	SupplementData
WorkflowParameters	string	任意	ワークフローのパラメーター。特定のワークフローが指定された場合（`WorkflowId != 1`）に有効になります。スケジュール実行型およびトリガー型ワークフローでは、形式は key=value であり、タスクパラメーターと比較して優先度が低くなります。手動実行型ワークフローでは、形式は JSON であり、タスクパラメーターと比較して優先度が高くなります。	"key=value" format: key1=value1 key2=value2 JSON format: {"key1":"value1", "key2": "value2"}
TaskParameters	string	任意	タスク固有のパラメーター。値は JSON 形式です。キーはタスク ID を指定します。GetTask 操作を呼び出して、スクリプトパラメーターを照会することで、値の形式を取得できます。	{ "1001": "key1=val2 key2=val2", "1002": "key1=val2 key2=val2" }
AutoStartEnabled	boolean	任意	デフォルト値は true です。	true
DefaultRunProperties	object	任意	ランタイム構成。
RootTaskIds	array	任意	ルートタスク ID の一覧。 Type が SupplementData の場合、Mode が Chain でない限り RootTaskIds の指定は必須です。 Type が ManualWorkflow の場合、RootTaskIds は任意指定です。未指定の場合は、手動実行型ワークフローのデフォルトルートノードが使用されます。 Type が Manual の場合、RootTaskIds は必須であり、実行対象の手動タスクの一覧を指定します。 Type が SmokeTest の場合、RootTaskIds は必須であり、実行対象のテストタスクの一覧を指定します。
	integer	任意	タスク ID。	1234
IncludeTaskIds	array	任意	実行対象のタスク ID。
	integer	任意	タスク ID。	1234
ExcludeTaskIds	array	任意	実行対象外のタスク ID。
	integer	任意	タスク ID。	4321
IncludeProjectIds	array	任意	実行対象のプロジェクト ID。
	integer	任意	プロジェクト ID。	100
ExcludeProjectIds	array	任意	実行対象外のプロジェクト ID。
	integer	任意	プロジェクト ID。	200
Mode	string	任意	データバックフィルモード。デフォルト値：ManualSelection。Type が SupplementData の場合に必須です。 General：RootTaskIds には 1 つの値のみ指定可能です。`IncludeTaskIds` パラメーターは任意指定です。未指定の場合は、デフォルトで `RootTaskIds` が含まれます。 ManualSelection：RootTaskIds には複数の値を指定可能です。`IncludeTaskIds` パラメーターは任意指定です。未指定の場合は、デフォルトで `RootTaskIds` が含まれます。 Chain：Mode パラメーターを Chain に設定する場合、`RootTaskIds` パラメーターは空欄のままにして、`IncludeTaskIds` パラメーターに開始タスク ID と終了タスク ID を設定します。 AllDownstream：RootTaskId は 1 つだけ指定可能です。	ManualSelection
Analysis	object	任意	分析構成。Type = SupplementData の場合に必須です。
Enabled	boolean	任意	分析機能を有効化するかどうかを指定します。Type = SupplementData の場合に必須です。	true
Blocked	boolean	任意	分析が失敗した場合に実行をブロックするかどうかを指定します。Type = SupplementData の場合に必須です。	true
RunPolicy	object	任意	実行ポリシー。このパラメーターを空欄のままにした場合、タスク構成が使用されます。
StartTime	string	任意	実行開始時刻。このパラメーターは `hh:mm:ss` 形式（24 時間表記）で設定してください。RunPolicy パラメーターを設定する場合は、このパラメーターの指定が必須です。	00:00:00
EndTime	string	任意	実行終了時刻。このパラメーターは `hh:mm:ss` 形式（24 時間表記）で設定してください。RunPolicy パラメーターを設定する場合は、このパラメーターの指定が必須です。有効な値：	23:59:59
Type	string	任意	時間帯タイプ。RunPolicy パラメーターを設定する場合は、このパラメーターの指定が必須です。有効な値： Daily Weekend	Daily
Immediately	boolean	任意	スケジュール実行時刻が将来であるタスクを即時に実行できるかどうかを指定します。デフォルト値：false。	false
Alert	object	任意	アラート設定。
Type	string	任意	アラート通知ポリシー。有効な値： Success：成功時にアラートを送信します。 Failure：失敗時にアラートを送信します。 SuccessFailure：成功時および失敗時にアラートを送信します。	Succes
NoticeType	string	任意	アラート通知方法。有効な値： Sms：SMS のみ。 Mail：メールのみ。 SmsMail：SMS およびメール。	Sms
Parallelism	integer	任意	タスクの同時実行数。2～10 の値は同時実行を意味し、1 の値は順次実行を意味します。Type = SupplementData の場合に必須です。	2
Order	string	任意	実行順序。デフォルト値：Asc。 Asc：ビジネス日付の昇順。 Desc：ビジネス日付の降順。	Asc
RuntimeResource	string	任意	カスタムスケジューリングリソースグループ ID。空欄の場合は、タスク構成が使用されます。	S_res_group_524258031846018_1684XXXXXXXXX
Priority	integer	任意	実行優先度（範囲：1～11）。値が大きいほど優先度が高くなります。	1
PriorityWeightStrategy	string	任意	優先度重み付けポリシー。 `Disable`（デフォルト）：無効化します。 `Upstream`：優先度は上流ノードの合計重みに基づきます。階層が深いほど重みが高くなります。	Upstream
Comment	string	任意	作成理由。	create for test
Tags	array<object>	任意	タスクタグ一覧。
	object	任意
Value	string	任意	タグ値。	tagValue
Key	string	任意	タグキー。	tagKey
TagCreationPolicy	string	任意	タグ作成ポリシー。有効な値： Append：既存の手動実行型ワークフローのタグに新しいタグを追加します。 Overwrite：手動実行型ワークフローの既存のタグは継承されず、新しいタグが直接作成されます。	Append

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。ログの特定やトラブルシューティングに使用されます。	22C97E95-F023-56B5-8852-B1A77A17XXXX
OperationId	string	操作 ID。このフィールドを使用して、GetCreateWorkflowInstancesResult インターフェイス経由で、作成操作の結果を照会できます。	e15ad21c-b0e9-4792-8f55-b037xxxxxxxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "OperationId": "e15ad21c-b0e9-4792-8f55-b037xxxxxxxx"
}

エラーコード

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

変更履歴

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