全部產品
Search

搜尋本產品

    DataWorks：StartDISyncInstance - 啟動即時同步任務和解決方案同步任務

    文件中心

    DataWorks：StartDISyncInstance - 啟動即時同步任務和解決方案同步任務

    更新時間：Mar 21, 2026

    調用StartDISyncInstance介面，啟動即時同步任務和解決方案同步任務。

    調試

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

    調試

    授權資訊

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

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

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dataworks:*

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ProjectId

    integer

    是

    DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。 該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。

    10000
    TaskType

    string

    是

    啟動Data Integration同步任務的任務類型。 目前僅支援使用 DI_REALTIME 和 DI_SOLUTION 兩種類型：

    • DI_REALTIME 代表啟動即時任務。

    • DI_SOLUTION 代表啟動解決方案。

    DI_REALTIME
    FileId

    integer

    是

    • 當 TaskType 參數配置為 DI_REALTIME，則 FileId 為即時同步任務的任務 ID。

    • 當 TaskType 參數配置為 DI_SOLUTION，則 FileId 為解決方案同步任務的任務 ID。

    100
    StartParam

    string

    否

    • 當 TaskType 參數配置為 DI_REALTIME，則 StartParam 為即時同步任務的啟動參數，包括 Failover 的設定，髒資料條數，以及 DDL 的參數配置。

    • 當 TaskType 參數配置為 DI_SOLUTION，則 StartParam 參數無意義。

    {"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回對象。

    Success

    boolean

    請求是否成功。取值如下：

    • true：成功。

    • false：失敗。

    true
    RequestId

    string

    請求 ID。用於定位日誌，排查問題。

    0bc1411515937635973****
    Data

    object

    啟動同步任務的結果。

    Status

    string

    啟動同步任務的結果狀態。取值如下：

    • success：同步任務啟動成功。

    • fail：同步任務啟動失敗。您可以查看具體原因，處理相關問題。

    success
    Message

    string

    啟動Data Integration同步任務失敗後的原因描述。

    如果啟動Data Integration同步任務成功，則該參數的傳回值為空白。

    fileId:[100] is invalid.

    樣本

    正常返回樣本

    JSON格式

    {
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "success",
    "Message": "fileId:[100] is invalid."
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Param.Invalid The parameter is invalid. 參數錯誤
    500 InternalError.System An internal error occurred. 內部報錯
    403 Forbidden.Access Access is forbidden.

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

    變更歷史

    更多資訊，參考變更詳情。