全部產品
Search
文件中心

DataWorks:GetDISyncTask - 查詢資料同步任務

更新時間:Mar 21, 2026

擷取Data Integration即時同步任務和同步解決方案的詳情。

調試

您可以在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:表示Data Integration即時同步任務。

  • DI_SOLUTION:表示Data Integration同步解決方案。

DI_REALTIME

FileId

integer

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

  • 當 TaskType 為 DI_SOLUTION 時,則 FileId 為同步解決方案的任務 ID。

您可以調用 ListFiles 介面擷取任務 ID。

100

返回參數

名稱

類型

描述

樣本值

object

擷取Data Integration任務的返回結果。

Success

boolean

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

  • True:成功。

  • False:失敗。

true

RequestId

string

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

0bc1411515937635973****

Data

object

擷取Data Integration任務的返回結果。

Code

string

  • 如果 TaskType 為 DI_REALTIME,則擷取即時同步任務的詳情。

  • 如果 TaskType 為 DI_SOLUTION,則為 null。

{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}

Status

string

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

Success:表示擷取Data Integration同步任務成功。 Fail:表示擷取Data Integration同步任務失敗。

success

Message

string

擷取Data Integration同步任務失敗後的原因描述。

如果擷取Data Integration同步任務成功,則該參數的傳回值為空白。

fileId:[100] is invalid.

AlarmList

array<object>

即時任務相關聯的警示規則數組。

array<object>

單條即時任務相關聯的警示規則。

Id

integer

警示規則 id。

45242

Enabled

boolean

警示規則是否啟動。

true

RuleName

string

警示規則名稱。

Delay alert rule name 1

Metric

string

警示類型:

  • taskStatus 任務狀態

  • bizDelay 業務延遲

  • taskFailoverCount 監控 Failover

  • ddlUnsupport DDL 不支援

  • ddlReport DDL 通知

  • totalDirtyRecordWriteInLines 髒資料

taskStatus

Description

string

警示規則描述。

Description

AlarmRuleList

array<object>

警示通知配置數組。

object

警示通知配置。

Level

string

  • WARNING 警告警示

  • CRITICAL 嚴重警示

WARNING

Comparator

string

比較符號,指標和警示規則的比較方法:

  • '='

  • '<'

  • '>'

=

Threshold

integer

指標和警示規則的比較閾值。

1

Duration

integer

期間,滿足該條件持續多久才會觸發警示,單位分鐘。

3

Aggregator

string

指標的計算方法:

  • avg 區間取平均

  • max 區間取最大值

avg

NotifyRule

object

警示通知規則數組。

Interval

integer

警示間隔,單位分鐘。

5

Warning

array

Warning 層級警示通知清單。

string

通道,可選的枚舉值:

  • Mail(郵件)

  • Phone(電話)

  • Sms(簡訊)

  • Ding(DingTalk)

Ding

Critical

array

Critical 層級警示通知清單。

string

通道,可選的枚舉值:

  • Mail(郵件)

  • Phone(電話)

  • Sms(簡訊)

  • Ding(DingTalk)

Ding

SolutionDetail

object

  • 如果 TaskType 為 DI_REALTIME,則為 null。

  • 如果 TaskType 為 DI_SOLUTION,則擷取同步解決方案任務的詳情。

Status

string

同步解決方案的執行狀態

  • 0-成功

  • 1-未運行

  • 2-運行中

  • 3-失敗

  • 4-提交

  • 5-待人工確認

  • 6-人工確認完成

  • 7-其他

  • 8-等待

  • 9-已刪除

0

Type

string

同步解決方案任務的類型。

holo

StartTime

string

同步解決方案任務的開始時間。

2021-12-07 14:40:51

CreatorName

string

同步解決方案任務的建立者名稱。

dataworks_di

ProjectId

integer

同步解決方案任務所在的專案 ID。

10000

SourceType

string

同步解決方案任務源端的類型。

mysql

ProcessContent

string

同步解決方案的配置詳情。

{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}

Name

string

同步解決方案任務的名稱。

holo_20211206161025

ProcessExtra

string

同步解決方案任務的額外參數。

{"processType":"new","tableNum":300}

SubmitTime

string

同步解決方案任務提交的時間。

2021-12-07 14:40:51

Id

integer

同步解決方案的任務 ID。

100

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0bc1411515937635973****\t",
  "Data": {
    "Code": "{\"extend\":{\"mode\":\"wizard\",\"resourceGroup\":\"S_res_group_287114642182658_1560324290517\"},\"nodeDef\":{},\"order\":{\"hops\":[{\"from\":\"datahub_8htXSsfiS2vtZCVG\",\"to\":\"datahub_CRHBAyGfhSaLmv2f\"}]},\"setting\":{\"errorLimit\":{},\"jvmOption\":\"\"},\"steps\":[{\"stepType\":\"datahub\",\"category\":\"writer\",\"displayName\":\"DataHub1\",\"parameter\":{\"batchSize\":1000,\"datasource\":\"datahub_cloud_dev_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt\"},\"name\":\"datahub_CRHBAyGfhSaLmv2f\",\"gui\":{\"x\":262,\"y\":325}},{\"stepType\":\"datahub\",\"displayName\":\"DataHub2\",\"parameter\":{\"datasource\":\"datahub_uric_test\",\"topic\":\"dwd_tfc_opt_speed_rid_amap_rt_330000\",\"batchSize\":1000},\"name\":\"datahub_8htXSsfiS2vtZCVG\",\"gui\":{\"x\":268,\"y\":160.5},\"category\":\"writer\"}]}",
    "Status": "success",
    "Message": "fileId:[100] is invalid.",
    "AlarmList": [
      {
        "Id": 45242,
        "Enabled": true,
        "RuleName": "Delay alert rule name 1",
        "Metric": "taskStatus",
        "Description": "Description",
        "AlarmRuleList": [
          {
            "Level": "WARNING",
            "Comparator": "=",
            "Threshold": 1,
            "Duration": 3,
            "Aggregator": "avg"
          }
        ],
        "NotifyRule": {
          "Interval": 5,
          "Warning": [
            "Ding"
          ],
          "Critical": [
            "Ding"
          ]
        }
      }
    ],
    "SolutionDetail": {
      "Status": "0",
      "Type": "holo",
      "StartTime": "2021-12-07 14:40:51",
      "CreatorName": "dataworks_di",
      "ProjectId": 10000,
      "SourceType": "mysql",
      "ProcessContent": "{\"holoDatasource\":\"holo\",\"offlineSyncConfig\":{\"nodeNameRule\":\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\",\"resourceGroup\":\"group_219193793999490\"},\"processRuleId\":1007,\"readerConcurrent\":10,\"realtimeSyncConfig\":{\"content\":{\"order\":{\"hops\":[{\"from\":\"reader\",\"to\":\"writer\"}]},\"setting\":{\"speed\":{\"readerConcurrent\":10}},\"steps\":[{\"stepType\":\"mysql\",\"name\":\"reader\",\"category\":\"reader\",\"parameter\":{\"connection\":[{\"datasource\":\"mm\",\"datasourceType\":\"mysql\",\"table\":[]}]}},{\"stepType\":\"holo\",\"name\":\"writer\",\"category\":\"writer\",\"parameter\":{\"datasource\":\"holo\",\"writeMode\":\"replay\",\"datasourceSchema\":\"public\",\"tableMappingRule\":{\"datasource\":[{\"tableRule\":[],\"srcDatasourceName\":\"mm\"}]}}}]},\"extend\":{\"mode\":\"migration_holo\",\"resourceGroup\":\"group_219193793999490\"}},\"setting\":{\"autoCreateWorkflow\":true,\"userDefinedFileNameExpression\":\"oneclick\"},\"srcType\":\"mysql\",\"tableMappingRuleFromRealtimeSyncConfig\":{\"datasource\":[{\"srcDatasourceName\":\"mm\",\"tableRule\":[]}]}}",
      "Name": "holo_20211206161025",
      "ProcessExtra": "{\"processType\":\"new\",\"tableNum\":300}",
      "SubmitTime": "2021-12-07 14:40:51",
      "Id": 100
    }
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

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

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

變更歷史

更多資訊,參考變更詳情