タスクフローのスケジューリングプロパティを更新します。
操作説明
この操作を呼び出して、編集状態のタスクフローのスケジューリングプロパティを更新できます。時間指定スケジューリングタスクフローまたはイベントスケジューリングタスクフローを設定できます。時間指定スケジューリングタスクフローを設定する場合、1回限りのスケジューリングまたは定期的なスケジューリングを選択できます。イベントスケジューリングタスクフローを設定する場合、タスクフローまたはタスクフローノードをサブスクライブできます。****
スケジューリングプロパティを更新した後、タスクフローを再度公開してデプロイする必要があります。新しいタスクフローインスタンスは、更新されたスケジューリングプロパティに基づいて実行されます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dms:UpdateTaskFlowSchedule |
update |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Tid |
integer |
任意 |
テナントの ID です。 説明
:テナントの ID を表示するには、Data Management (DMS) コンソールにログインし、右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。 |
3*** |
| DagId |
integer |
必須 |
タスクフローの ID です。 |
7*** |
| ScheduleSwitch |
boolean |
必須 |
スケジューリングを有効にするかどうかを指定します。有効な値:
|
false |
| CronBeginDate |
string |
任意 |
スケジューリングの時間範囲の開始時刻です。 |
CronBeginDate_test |
| CronEndDate |
string |
任意 |
スケジューリングの時間範囲の終了時刻です。 |
CronEndDate_test |
| ScheduleParam |
string |
必須 |
イベントスケジューリングの設定です。このパラメーターの値は JSON 文字列です。 |
ScheduleParam_test |
| CronStr |
string |
任意 |
時間指定スケジューリングの cron 式です。 |
CronStr_test |
| TriggerType |
string |
必須 |
タスクフローがトリガーされるモードです。有効な値:
|
Event |
| CronType |
string |
任意 |
スケジューリング周期のタイプです。有効な値:
|
HOUR |
| TimeZoneId |
string |
任意 |
タイムゾーンです。デフォルトのタイムゾーンは UTC+8 (Asia/Shanghai) です。 |
Asia/Shanghai |
スケジューリング設定パラメーターに関する注意事項
時間指定スケジューリングタスクフローを設定する場合、1回限りのスケジューリングまたは定期的なスケジューリングを選択できます。
次のパラメーターは必須です:
ScheduleSwitch: True
TriggerType: Cron
CronBeginDate
CronEndDate
CronStr
CronType
ScheduleParam:タスクは日、週、月単位、または1回のみ実行できます。
以下に例を示します:
日単位のスケジューリング:
{
"triggerType":"0",
"dateTime":"00:00"
}
週単位のスケジューリング:「1」は日曜日、「2」は月曜日、...、「7」は土曜日を表します。
{
"triggerType":"0",
"dateWeek":[
"1",
"5"
],
"weekTime":"00:00"
}
月単位のスケジューリング:
{
"triggerType":"0",
"dateMonth":"1",
"MonthTime":"00:00"
}
1回限りのスケジューリング:
{
"triggerType":"1",
"specificTime":"2022-09-02 00:00"
}
パラメーターの説明
CronStr:CronStr はタスクフローのスケジューリング方法を定義します。
CronBeginDate と CronEndDate:定期的なスケジューリングの場合、CronBeginDate、CronEndDate、および CronStr がタスクフローのスケジューリングを定義します。CronStr で指定された時刻が CronBeginDate と CronEndDate の間の時間範囲内にある場合、タスクがトリガーされます。
CronType:これは検証に使用されます。CronStr で指定されたスケジューリング周期に基づいて値を入力します。
ScheduleParam:CronStr で指定されたスケジューリング設定に基づいて値を入力します。
イベントスケジューリング (タスクフロー間で自動的にトリガー)
次のパラメーターは必須です:
ScheduleSwitch: True
TriggerType: Event
ScheduleParam
以下に例を示します:
{
"triggerType":"2", // スケジューリングタイプ。値 2 はイベントスケジューリングを示します。
"deps":[ // タスクフローとタスクノードのサブスクリプション構成。
{
"eventType":1, // サブスクリプションのタイプ。値 0 はタスクフローへのサブスクリプションを示します。値 1 はタスクノードへのサブスクリプションを示します。
"lisDagId":12345, // サブスクライブ対象のノードが属するタスクフロー。
"lisNodeId":2134 // サブスクライブするノードの ID。
},
{
"eventType":0,
"lisDagId":12343 // サブスクライブするタスクフローの ID。
},
{
"eventType":0,
"lisDagId":23456
}
],
"maxWait":21600 // サブスクライブする先行するすべてのタスクフローまたはノードが実行されるまでの最大待機時間。
}
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| RequestId |
string |
リクエストの ID です。この ID を使用して、ログのクエリや問題のトラブルシューティングができます。 |
7BF38A13-C181-5B5E-97F1-8643F8A10093 |
| ErrorCode |
string |
リクエストが失敗した場合に返されるエラーコードです。 |
InvalidParameterValid |
| ErrorMessage |
string |
リクエストが失敗した場合に返されるエラーメッセージです。 |
InvalidParameterValid |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"RequestId": "7BF38A13-C181-5B5E-97F1-8643F8A10093",
"ErrorCode": "InvalidParameterValid",
"ErrorMessage": "InvalidParameterValid",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。