全部產品
Search
文件中心

DataWorks:DeployDISyncTask

更新時間:Oct 09, 2026

該介面用於發佈即時同步任務。

介面說明

呼叫時需指定目標 DataWorks 工作空間所在地域。RegionId 是用於選擇地域端點的主機級參數,例如 cn-hangzhou 對應杭州地域端點。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

是

DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間管理頁面取得 ID。

該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。

10000

TaskType

string

是

目標資料來源所關聯的資料集成同步任務的任務類型。取值如下:

  • DI_REALTIME:表示資料集成即時同步任務。

  • DI_SOLUTION:表示資料集成主站同步任務。

DI_REALTIME

FileId

integer

是

  • 當 TaskType 為 DI_REALTIME 時,則 FileId 為即時同步任務的檔案 ID。

  • 當 TaskType 為 DI_SOLUTION 時,則 FileId 為主站同步任務的任務 ID。

您可以呼叫 ListFiles 介面取得任務 ID。

100

返回參數

名稱

類型

描述

樣本值

object

資料集成同步任務回傳結果。

Success

boolean

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

  • true:成功。

  • false:失敗。

true

RequestId

string

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

0bc14115159376359******

Data

object

發佈同步任務的結果。

Status

string

發佈資料集成同步任務的結果狀態。取值如下:

  • success:表示發佈資料集成同步任務成功。

  • fail:表示發佈資料集成同步任務失敗。

success

Message

string

發佈資料集成同步任務失敗後的原因描述。

如果發佈資料集成同步任務成功,則該參數的回傳值為空。

submit and deploy fail.

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0bc14115159376359******",
  "Data": {
    "Status": "success",
    "Message": "submit and deploy fail."
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

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