タスクフローのスケジューリング構成を更新します。
操作説明
この操作は、編集モードでタスクフローのスケジューリング設定を更新します。時間指定スケジューリング、定期スケジューリング、およびイベントスケジューリングを設定できます。時間指定スケジューリングは、1 回限りのスケジューリングまたは定期スケジューリングをサポートします。イベントスケジューリングは、タスクフローおよびタスクフローノードのサブスクリプションをサポートします。
構成の更新後、タスクフローを再公開してデプロイしてください。その後、新しいタスクフローインスタンスは更新されたスケジューリング設定に基づいてスケジューリングされます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dms:UpdateTaskFlowSchedule |
update |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Tid |
integer |
任意 |
テナント ID。 説明
コンソールの右上隅にあるプロフィール画像にポインターを合わせると、テナント ID を確認できます。詳細については、「テナント情報の表示」を参照してください。 |
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 |
任意 |
タイムゾーン設定。デフォルト値: Asia/Shanghai (協定世界時 (UTC)+8)。 |
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。ログの特定や問題のトラブルシューティングに使用されます。 |
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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。