調用ListDIProjectConfig介面查看Data Integration同步解決方案的全域配置-巨量資料開發治理平台 DataWorks-阿里雲

介面說明

當前 DataWorks 僅支援為同步解決方案任務中的即時同步 DDL 訊息處理原則設定預設的全域配置。如果您的同步解決方案任務包含即時同步任務，則配置 DDL 訊息處理規則時會讀取此處的全域配置為預設配置。您也可以根據實際業務需求修改目標同步任務的預設DDL 訊息處理規則為所需的配置。配置Data Integration同步解決方案任務，詳情請參見配置同步解決方案任務。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dataworks:*

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間配置頁面擷取工作空間 ID。	1000
DestinationType	string	是	Data Integration同步解決方案任務的目的端資料來源。該參數不可為空。調用 ListDIProjectConfig 查看同步解決方案的全域配置目前僅支援配置目的端資料來源為 analyticdb_for_mysql、odps、elasticsearch、holo、mysql 及 polardb。	elasticsearch
SourceType	string	否	Data Integration同步解決方案任務的源端資料來源。調用 ListDIProjectConfig 查看同步解決方案的全域配置目前僅支援配置源端資料來源為 oracle、mysql、polardb、datahub、drds 及 analyticdb_for_mysql。如果不配置源端資料來源，則預設全域配置對所有的源端資料來源均生效。	mysql

返回參數

名稱	類型	描述	樣本值
	object
Success	boolean	請求是否成功。取值如下： true：成功。 false：失敗。	true
RequestId	string	本次調用的唯一 ID。用於出現錯誤後定位日誌，排查問題。	0000-ABCD-EFG
Data	object	查看目標工作空間中Data Integration同步解決方案任務預設全域配置的返回結果。
Config	string	Data Integration同步解決方案任務預設的全域配置內容（即對不同 DDL 訊息類型配置的預設處理策略）。樣本如下： {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"} DDL 訊息類型如下： RENAMECOLUMN：重新命名列。 DROPTABLE：刪除表。 CREATETABLE：建立表。 MODIFYCOLUMN：修改列類型。 TRUNCATETABLE：清空表。 DROPCOLUMN：刪除列。 ADDCOLUMN：新增列。 RENAMETABLE：重新命名表。 DataWorks 收到對應類型的 DDL 訊息時，處理策略如下： WARNING：直接丟棄該訊息，同時會在即時同步處理記錄中記錄警示資訊，指明該訊息因執行出錯被丟棄。 IGNORE：直接丟棄該訊息，不再向目的端資料來源發送。 CRITICAL：即時同步任務直接顯示出錯狀態並終止運行。 NORMAL：將相應訊息繼續下發給目的端資料來源，由目的端資料來源來處理。因為不同目的端資料來源對 DDL 訊息處理策略可能會不同，因此 DataWorks 只執行轉寄操作。	{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Config": "{\"RENAMECOLUMN\":\"WARNING\",\"DROPTABLE\":\"WARNING\",\"CREATETABLE\":\"WARNING\",\"MODIFYCOLUMN\":\"WARNING\",\"TRUNCATETABLE\":\"WARNING\",\"DROPCOLUMN\":\"WARNING\",\"ADDCOLUMN\":\"WARNING\",\"RENAMETABLE\":\"WARNING\"}"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Invalid.DI.Parameter	The parameter is invalid.	參數錯誤
500	InternalError.DI.Parameter	A DI internal error occurred.	Data Integration內部業務錯誤
403	Forbidden.DI.NoPrivilege	No access.	沒有許可權訪問

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

變更歷史

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