更新Data Integration新版任務,當前支援的任務類型包括:MySQL到Hologres整庫即時解決方案。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DIJobId |
integer |
否 |
任務 ID。 |
11588 |
| Description |
string |
否 |
任務描述。 |
mysql同步到hologres |
| ResourceSettings |
object |
否 |
資源設定。 |
|
| OfflineResourceSettings |
object |
否 |
離線同步資源。 |
|
| ResourceGroupIdentifier |
string |
否 |
離線同步使用的Data Integration資源群組標識。 |
S_res_group_111_222 |
| RealtimeResourceSettings |
object |
否 |
即時同步資源。 |
|
| ResourceGroupIdentifier |
string |
否 |
即時同步使用的Data Integration資源群組標識。 |
S_res_group_111_222 |
| RequestedCu |
number |
否 |
增全量同步任務使用的資源群組 cu。 |
2.0 |
| TransformationRules |
array<object> |
否 |
同步對象轉換規則定義列表,列表中每個元素為一條轉換規則定義。 |
|
|
object |
否 |
同步對象轉換規則定義。 |
||
| RuleName |
string |
否 |
規則名稱,當動作類型和動作作用的目標類型相同時,規則名稱需保證唯一性。 |
rename_rule_1 |
| RuleActionType |
string |
否 |
動作類型,可選的枚舉值:
|
Rename |
| RuleTargetType |
string |
否 |
動作作用的目標類型,可選的枚舉值:
|
Table |
| RuleExpression |
string |
否 |
規則運算式,json string 格式。 重新命名規則(Rename)樣本: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]} expression:為重新命名轉換規則運算式,運算式內支援變數包括:${srcDatasourceName}(源端資料來源名)、${srcDatabaseName}(源端庫名)、${srcTableName}(源端表名)。 variables:為重新命名轉換規則運算式中各變數的建置規則,參數預設值為對應含義在源端的原始值,可按需定義一組字串替換規則對原始值進行改寫。variableName:變數名,不含${}。variableRules:變數建置規則組,按順序串列執行替換,from 原始字串;to 替換後字串。 在目標端增加指定列並賦值規則(AddColumn)樣本: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]} 如不指定,預設規則為不加列不複製。 columnName:附加的列名稱。 columnValueType:附加的列取實值型別,包括 Constant(常量)、Variable(變數)。 columnValue:附加的列取值。當 valueType=Constant 時,value 為自訂常量,String 類型。當 valueType=Variable 時,value 為內建變數。內建變數可選值包括:EXECUTE_TIME(執行時間,Long 類型)、DB_NAME_SRC(源端資料庫名稱,String 類型)、DATASOURCE_NAME_SRC(源端資料來源名稱,String 類型)、TABLE_NAME_SRC(源端表名,String 類型)、DB_NAME_DEST(目標端資料庫名稱,String 類型)、DATASOURCE_NAME_DEST(目標端資料來源名稱,String 類型)、TABLE_NAME_DEST(目標端表名,String 類型)、DB_NAME_SRC_TRANSED(轉換後的資料庫名稱,String 類型)。 指定目標端表的主鍵列列名(DefinePrimaryKey)樣本: {"columns":["ukcolumn1","ukcolumn2"]} 如不指定預設使用源端主鍵列。 當目標端為已有表:Data Integration系統不會修改目標端表結構,如果指定的主鍵列不在目標端的列集合中,任務啟動會報錯提示。 當目標端為自動建表:Data Integration系統會自動建立目標端表結構,表結構包含定義的主鍵列。當指定的主鍵列不在目標端的列集合中時,任務啟動會報錯提示。 DML 處理規則(HandleDml)樣本: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]} 如不指定,預設規則為 Insert、Update、Delete 均為 Normal dmlType:DML 操作類型,Insert(插入)、Update(更新)、Delete(刪除) dmlAction:DML 處理策略,Normal(正常處理)、Ignore(忽略)、Filter(有條件的正常處理,當 dmlType=Update/Delete 時使用)、LogicalDelete(邏輯刪除) filterCondition:DML 過濾條件,當 dmlAction=Filter 時使用 |
{"expression":"${srcDatasoureName}_${srcDatabaseName}"} |
| TableMappings |
array<object> |
否 |
同步對象轉換映射列表,列表中每個元素描述了一組源端同步對象選擇規則列表和在該組同步對象上應用的同步對象轉換規則列表。 |
|
|
array<object> |
否 |
同步對象轉換映射。 |
||
| SourceObjectSelectionRules |
array<object> |
否 |
源端對象選擇規則,支援多條。 |
|
|
object |
否 |
每條規則可選擇待同步源端對象的不同物件類型,如選擇源端資料庫、源端資料表。 |
||
| ObjectType |
string |
否 |
物件類型,可選的枚舉值:
|
Table |
| Expression |
string |
否 |
運算式。 |
mysql_table_1 |
| TransformationRules |
array<object> |
否 |
源端對象上應用的轉換規則列表。 |
|
|
object |
否 |
源端對象上應用的轉換規則。 |
||
| RuleName |
string |
否 |
規則名稱,在一種動作類型+動作作用的目標類型下規則名稱唯一。 |
rename_rule_1 |
| RuleActionType |
string |
否 |
動作類型,可選的枚舉值:
|
Rename |
| RuleTargetType |
string |
否 |
動作作用的目標類型,可選的枚舉值;
|
Table |
| JobSettings |
object |
否 |
同步任務維度設定,含 DDL 處理策略、源端和目標端列資料類型映射策略、任務運行時參數等。 |
|
| DdlHandlingSettings |
array<object> |
否 |
DDL 處理設定,支援多值。 |
|
|
object |
否 |
DDL 處理設定。 |
||
| Type |
string |
否 |
DDL 類型,可選的枚舉值;
|
AddColumn |
| Action |
string |
否 |
處理動作,可選的枚舉值:
|
Critical |
| ColumnDataTypeSettings |
array<object> |
否 |
列類型映射,支援多值。 |
|
|
object |
否 |
列類型映射。 |
||
| SourceDataType |
string |
否 |
源端類型。 |
bigint |
| DestinationDataType |
string |
否 |
目標端類型。 |
text |
| RuntimeSettings |
array<object> |
否 |
運行時設定,支援多值。 |
|
|
object |
否 |
運行時設定。 |
||
| Name |
string |
否 |
設定名稱,可選的枚舉值:
|
runtime.offline.concurrent |
| Value |
string |
否 |
設定取值。 |
1 |
| CycleScheduleSettings |
object |
否 |
周期調度設定。 |
|
| ScheduleParameters |
string |
否 |
調度參數。 |
bizdate=$bizdate |
| ChannelSettings |
string |
否 |
通道相關任務設定,Json String 形式。 |
{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""} |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
響應。 |
||
| RequestId |
string |
請求 ID。 |
AAC30B35-820D-5F3E-A42C-E96BB6379325 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "AAC30B35-820D-5F3E-A42C-E96BB6379325"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。