すべてのプロダクト
Search
ドキュメントセンター

Data Management:UpdateTaskFlowSchedule

最終更新日:Mar 21, 2026

タスクフローのスケジューリングプロパティを更新します。

操作説明

この操作を呼び出して、編集状態のタスクフローのスケジューリングプロパティを更新できます。時間指定スケジューリングタスクフローまたはイベントスケジューリングタスクフローを設定できます。時間指定スケジューリングタスクフローを設定する場合、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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:UpdateTaskFlowSchedule

update

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナントの ID です。

説明

:テナントの ID を表示するには、Data Management (DMS) コンソールにログインし、右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。

3***

DagId

integer

必須

タスクフローの ID です。

7***

ScheduleSwitch

boolean

必須

スケジューリングを有効にするかどうかを指定します。有効な値:

  • Enable

  • Disable

false

CronBeginDate

string

任意

スケジューリングの時間範囲の開始時刻です。

CronBeginDate_test

CronEndDate

string

任意

スケジューリングの時間範囲の終了時刻です。

CronEndDate_test

ScheduleParam

string

必須

イベントスケジューリングの設定です。このパラメーターの値は JSON 文字列です。

ScheduleParam_test

CronStr

string

任意

時間指定スケジューリングの cron 式です。

CronStr_test

TriggerType

string

必須

タスクフローがトリガーされるモードです。有効な値:

  • Cron:タスクフローは時間指定スケジューリングに基づいてトリガーされます。

  • Event:タスクフローはイベントによってトリガーされます。

Event

CronType

string

任意

スケジューリング周期のタイプです。有効な値:

  • MINUTE:分単位のスケジューリング

  • HOUR:時間単位のスケジューリング

  • DAY:日単位のスケジューリング

  • WEEK:週単位のスケジューリング

  • MONTH:月単位のスケジューリング

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"
}

パラメーターの説明

  1. CronStr:CronStr はタスクフローのスケジューリング方法を定義します。

  2. CronBeginDate と CronEndDate:定期的なスケジューリングの場合、CronBeginDate、CronEndDate、および CronStr がタスクフローのスケジューリングを定義します。CronStr で指定された時刻が CronBeginDate と CronEndDate の間の時間範囲内にある場合、タスクがトリガーされます。

  3. CronType:これは検証に使用されます。CronStr で指定されたスケジューリング周期に基づいて値を入力します。

  4. 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:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

成功レスポンス

JSONJSON

{
  "RequestId": "7BF38A13-C181-5B5E-97F1-8643F8A10093",
  "ErrorCode": "InvalidParameterValid",
  "ErrorMessage": "InvalidParameterValid",
  "Success": true
}

エラーコード

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

変更履歴

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