全部產品
Search

搜尋本產品

    DataWorks：GenerateDISyncTaskConfigForCreating

    文件中心

    DataWorks：GenerateDISyncTaskConfigForCreating

    更新時間：Oct 09, 2026

    非同步產生同步任務的JSON。

    介面說明

    DataWorks 目前僅支援直接使用 CreateDISyncTask 介面建立資料整合離線同步任務，而資料整合即時同步任務和其他同步類型的任務則需要先呼叫 GenerateDISyncTaskConfigForCreating 和 QueryDISyncTaskConfigProcessResult 介面，取得非同步產生建立資料整合同步任務需要的參數，再將該參數作為 CreateDISyncTask 介面的輸入參數，使用 CreateDISyncTask 介面建立相應的即時同步任務和其他同步類型的同步任務。 僅支援使用非同步方式建立資料整合即時同步任務和其他同步類型的同步任務。

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ProjectId

    integer

    是

    DataWorks 工作空間的 ID。您可以登入 DataWorks 主控台，進入工作空間設定頁面取得工作空間 ID。

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

    10000
    TaskType

    string

    是

    使用非同步方式建立資料整合同步任務的任務類型。取值如下：

    • DI_REALTIME：表示即時同步任務。

    • DI_SOLUTION：表示其他同步類型的同步任務。

    僅支援使用非同步方式產生資料整合即時同步任務和其他同步類型的同步任務。

    DI_REALTIME
    TaskParam

    string

    是

    資料整合同步任務的指令碼。 目前支援建立的同步任務類型如下：

    • 同步 MySQL 資料至 MaxCompute。

    • 同步 MySQL 資料至 Kafka。

    • 同步 MySQL 資料至 Hologres。

    SelectedTables 用於多資料庫模式選擇同步資料表，Tables 用於單一資料庫模式選擇同步資料表。

    • 當指令碼中包含 SelectedTables 陳述式時，系統會使用 SelectedTables 陳述式中的資料表資訊進行同步。

    • 當指令碼中包含 Tables 陳述式時，系統會使用 Tables 的欄位資訊進行同步。

    同步 MySQL 資料至 MaxCompute，範例陳述式如下。

    {
  "type": "realtime",
  "version": "1.0",
  "setting": {
    "resourceGroup": "S_res_group_280749521950784_1623033752022",
    "taskType": "oneclick_to_odps"
  },
  "steps": [
    {
      "stepType": "mysql",
      "parameter": {
        "connection": [
          {
            "datasourceType": "mysql",
            "datasource": "mysql_pub1",
            "selectedTables": [
              {
                "dbName": "mysql_db",
                "schema": [
                  {
                    "tableInfos": [
                      {
                        "table": "molin_di_test_in_pk_v4"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      "name": "Reader",
      "category": "reader"
    },
    {
      "stepType": "odps",
      "parameter": {
        "datasource": "odps_source"
      },
      "name": "Writer",
      "category": "writer"
    }
  ]
}

    同步 MySQL 資料至 Kafka，範例陳述式如下。

    {
  "type": "realtime",
  "version": "1.0",
  "setting": {
    "resourceGroup": "S_res_group_280749521950784_1623033752022",
    "taskType": "oneclick_to_kafka"
  },
  "steps": [
    {
      "stepType": "mysql",
      "parameter": {
        "connection": [
          {
            "datasourceType": "mysql",
            "datasource": "pkset_test",
            "selectedTables": [
              {
                "dbName": "mysql_db",
                "schema": [
                  {
                    "tableInfos": [
                      {
                        "table": "molin_di_test_in_pk_v4"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      "name": "Reader",
      "category": "reader"
    },
    {
      "stepType": "kafka",
      "parameter": {
        "datasource": "azn_kafka"
      },
      "name": "Writer",
      "category": "writer"
    }
  ]
}

    同步 MySQL 資料至 Hologres，範例陳述式如下。

    {
  "type": "realtime",
  "version": "1.0",
  "setting": {
    "resourceGroup": "S_res_group_280749521950784_1623033752022",
    "taskType": "oneclick_to_holo"
  },
  "steps": [
    {
      "stepType": "mysql",
      "parameter": {
        "connection": [
          {
            "datasourceType": "mysql",
            "datasource": "mysql_pub",
            "selectedTables": [
              {
                "dbName": "mysql_db",
                "schema": [
                  {
                    "tableInfos": [
                      {
                        "table": "molin_di_test_in2_pk_v3"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      },
      "name": "Reader",
      "category": "reader"
    },
    {
      "stepType": "holo",
      "parameter": {
        "datasource": "holo"
      },
      "name": "Writer",
      "category": "writer"
    }
  ]
}

    { "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "taskType": "oneclick_to_odps" }, "steps": [{ "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub1", "selectedTables": [ { "dbName": "mysql_db", "schema": [ { "tableInfos": [ { "table": "molin_di_test_in_pk_v4" }] } ] } ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_source" }, "name": "Writer", "category": "writer" } ] }
    ClientToken

    string

    否

    冪等參數。用於避免多次呼叫導致操作重複。

    ABFUOEUOTRTRJKE

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    傳回結果。

    Success

    boolean

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

    • true：成功。

    • false：失敗。

    true
    RequestId

    string

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

    0bc1411515937635973****
    Data

    object

    非同步執行緒 ID 的產生結果。

    Status

    string

    產生非同步執行緒 ID 的結果狀態。取值如下：

    • success：表示成功產生非同步執行緒 ID。

    • fail：表示非同步執行緒 ID 產生失敗。您可以檢視失敗原因，處理相關問題。

    true
    ProcessId

    integer

    非同步執行緒 ID。您需要透過該 ID，呼叫 QueryDISyncTaskConfigProcessResult 介面取得非同步產生建立資料整合同步任務需要的參數，使用該參數建立資料整合同步任務。

    10
    Message

    string

    非同步執行緒 ID 產生失敗的原因描述。 如果成功產生非同步執行緒 ID，則該參數的傳回值為空。

    XXX is invalid.

    樣本

    正常返回樣本

    JSON格式

    {
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "true",
    "ProcessId": 10,
    "Message": "XXX is invalid."
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Invalid.DI.Parameter The parameter is invalid. 參數錯誤。
    400 Invalid.DI.Parameter.File.Existed The file name already exists. 參數不合法，檔案名稱已存在。
    500 InternalError.DI.Parameter A DI internal error occurred. 資料整合內部業務錯誤。
    403 Forbidden.DI.NoPrivilege No access. 沒有權限存取。

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

    變更歷史

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