全部產品
Search
文件中心

Data Management:UpdateTaskFlowSchedule

更新時間:Jul 31, 2026

呼叫 UpdateTaskFlowSchedule 介面,更新任務流排程設定。

介面說明

該介面用於更新編輯態任務流的排程設定。可設定定時排程週期排程事件排程;其中定時排程可設定排程一次或週期排程,事件排程可設定的訂閱包括任務流和任務流節點。
設定更新後,將任務流重新發佈並部署,新的任務流執行個體將按照設定的排程設定進行排程。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:UpdateTaskFlowSchedule

update

*全部資源。

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

租戶 ID。

說明

將滑鼠移動到介面右上角的頭像處,檢視租戶 ID。具體操作,請參見檢視租戶資訊

3***

DagId

integer

任務流 ID,任務流的唯一標識。

7***

ScheduleSwitch

boolean

是否啟用排程。

  • true

  • false

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

排程週期類型。取值如下:

  • HOUR:小時級排程

  • DAY:日級排程

  • WEEK: 週級排程

  • MONTH:月級排程

HOUR

TimeZoneId

string

時區設定,預設為東八區(Asia/Shanghai)。

Asia/Shanghai

排程設定相關參數說明

設定定時排程:可設定週期排程或排程一次。

必填參數如下:

  • ScheduleSwitch:True

  • TriggerType:Cron

  • CronBeginDate

  • CronEndDate

  • CronStr

  • CronType

  • ScheduleParam:分為按天、週、月、排程一次。

範例如下:

按「天」排程:

{
    "triggerType":"0",
    "dateTime":"00:00"
}

按「週」排程:週日為 1,週一為 2,…,週六為 7。

{
    "triggerType":"0",
    "dateWeek":[
        "1",
        "5"
    ],
    "weekTime":"00:00"
}

按「月」排程:

{
    "triggerType":"0",
    "dateMonth":"1",
    "MonthTime":"00:00"
}

排程一次:

{
    "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,用於定位日誌,排查問題。

7BF38A13-C181-5B5E-97F1-8643F8A10093

ErrorCode

string

錯誤碼。

InvalidParameterValid

ErrorMessage

string

呼叫失敗時,返回的錯誤資訊。

InvalidParameterValid

Success

boolean

請求是否成功,返回值如下:

  • true:請求成功

  • false:請求失敗

true

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情