全部產品
Search
文件中心

DataWorks:StopDISyncInstance - 停止即時同步任務

更新時間:Jul 31, 2026

調用StopDISyncInstance介面,停止即時同步任務。

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

ProjectId

integer

是

DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台,進入工作空間配置頁面擷取工作空間 ID。

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

10000

TaskType

string

是

停止Data Integration同步任務的任務類型。目前僅支援使用 DI_REALTIME 類型。

DI_REALTIME 代表即時任務。

DI_REALTIME

FileId

integer

是

FileId 為即時同步任務的 ID。您可以調用 ListFiles 介面擷取任務 ID。

100

返回參數

名稱

類型

描述

樣本值

object

返回對象。

Success

boolean

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

  • true:成功。

  • false:失敗。

true

RequestId

string

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

0bc1411515937635973****

Data

object

停止同步任務的結果。

Status

string

停止Data Integration同步任務的結果狀態。取值如下:

  • success:表示停止Data Integration同步任務成功。

  • fail:表示停止Data Integration同步任務失敗。

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.

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

變更歷史

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