UpdateDataQualityRuleTemplate - DataWorks

更新質量規則模板。

說明

目前該API介面已標記為棄用，推薦使用替代API：dataworks-public(2024-05-18) - UpdateDataQualityTemplate。

介面說明

需要購買 DataWorks 基礎版及以上版本才能使用

調試

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

調試

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
Code	string	是	規則模板 Code	USER_DEFINED:123
Name	string	否	規則模板名稱，數字、英文字母、漢字、半形全形標點符號組合，最長 512 個字元	Table row Count Verification
ProjectId	integer	是	DataWorks 工作空間的 ID。您可以登入 DataWorks 控制台，進入工作空間管理頁面取得 ID。該參數用來確定本次 API 呼叫操作使用的 DataWorks 工作空間。	10000
DirectoryPath	string	否	自訂模板被存放的類目目錄，斜線分隔層級。每個層級名稱最長 1024 個字元，不能包含空白字元、不能包含斜線	/ods/order_data
SamplingConfig	object	否	樣本採集所需的設定
Metric	string	否	採樣的指標名稱 Count：表行數 Min：欄位最小值 Max：欄位最大值 Avg：欄位均值 DistinctCount：欄位唯一值個數 DistinctPercent：欄位唯一值個數與資料行數佔比 DuplicatedCount：欄位重複值個數 DuplicatedPercent：欄位重複值個數與資料行數佔比 TableSize：表大小 NullValueCount：欄位為空的行數 NullValuePercent：欄位為空的比例 GroupCount：按欄位值彙總後每個值與對應的資料行數 CountNotIn：列舉值不符合行數 CountDistinctNotIn：列舉值不符合唯一值個數 UserDefinedSql：透過自訂 SQL 進行樣本採集	Max
MetricParameters	string	否	樣本採集時，所需的參數	{"SQL": "select count(1) from table;"}
SettingConfig	string	否	具體執行採樣語句前，插入執行的一些運行時參數設定語句，最長 1000 個字元。目前僅支援 MaxCompute	SET odps.sql.udf.timeout=600s; SET odps.sql.python.version=cp27;
CheckingConfig	object	否	樣本校驗設定
Type	string	否	監控對象類型 Table	Table
ReferencedSamplesFilter	string	否	有些類型的閾值需要查詢出一些參考樣本，然後對參考樣本的值進行彙總得出進行比較的閾值，這裡使用一個運算式來表示參考樣本的查詢方式	{ "bizdate": [ "-1", "-7", "-1m" ] }

返回參數

名稱	類型	描述	樣本值
	object	返回值
RequestId	string	Id of the request	691CA452-D37A-4ED0-****
Success	boolean	更新是否成功	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "691CA452-D37A-4ED0-****\n",
  "Success": true
}

錯誤碼

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

變更歷史

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