更新資料品質監控。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Description |
string |
否 |
資料品質監控描述資訊。 |
Daily data quality scanning of ods tables. |
| ProjectId |
integer |
否 |
資料品質監控所在的 DataWorks 工作空間 ID。您可以通過 ListProjects 介面擷取工作空間 ID。 |
101 |
| Id |
integer |
否 |
資料品質監控 ID。 |
10001 |
| Owner |
string |
否 |
資料品質監控負責人使用者識別碼。 |
231263586109857423 |
| Spec |
string |
否 |
資料品質監控的內容的 Spec 代碼，詳情請參見資料品質 Spec 配置說明。 |
{ "datasets": [ { "type": "Table", "dataSource": { "name": "odps_first", "envType": "Prod" }, "tables": [ "ods_d_user_info" ], "filter": "pt = $[yyyymmdd-1]" } ], "rules": [ { "assertion": "row_count > 0" }, { "templateId": "SYSTEM:field:null_value:fixed", "pass": "when = 0", "name": "The id cannot be empty.", "severity": "High", "identity": "a-customized-data-quality-rule-uuid" } ] } |
| Parameters |
array<object> |
否 |
資料品質監控執行參數定義。 |
|
|
object |
否 |
參數資訊。 |
||
| Value |
string |
否 |
參數值。 |
smtp.qiye.aliyun.com |
| Name |
string |
否 |
參數名。 |
temp_237669.zip_byBwm_1734661241752 |
| RuntimeResource |
object |
否 |
資料品質監控運行時，使用的資源群組。 |
|
| Id |
string |
否 |
資源群組 ID。 |
20315 |
| Cu |
number |
否 |
回合組態 CU 消耗。 |
0.25 |
| Image |
string |
否 |
任務回合組態的鏡像 ID。 |
i-xxxxxx |
| ComputeResource |
object |
否 |
資料品質監控在運行時使用的計算引擎，可空，如果沒有指定，則使用 Spec 中所指定的資料來源串連。 |
|
| Name |
string |
否 |
計算引擎名稱，唯一標識。 |
auto_createAlertRule_Finished_1kUTk6 |
| Runtime |
object |
否 |
使用計算引擎時的更多設定。 |
|
| Engine |
string |
否 |
使用的引擎類型，只有 EMR 計算引擎支援設定這部分內容。 取值範圍：
|
Hive |
| SparkConf |
object |
否 |
使用 Spark 引擎時，更多的參數設定，目前只支援通過 spark.yarn.queue 設定隊列。 |
spark.yarn.queue=dq_queue |
| HiveConf |
object |
否 |
使用 Hive 引擎時，更多的參數設定，目前只支援通過 mapreduce.job.queuename 設定隊列。 |
mapreduce.job.queuename=dq_queue |
| EnvType |
string |
否 |
計算引擎所屬的專案環境。取值範圍：
|
Prod |
| Trigger |
object |
否 |
資料品質監控觸發設定。 |
|
| Type |
string |
否 |
資料品質監控觸發方式。取值範圍：
|
BySchedule |
| TaskIds |
array |
否 |
當觸發方式為 BySchedule 時，需要配置觸發品質監控的調度任務 ID。 |
|
|
integer |
否 |
調度任務 Id。 |
30001 |
|
| Hooks |
array<object> |
否 |
資料品質監控運行結束後的 Hook 配置。 |
|
|
object |
否 |
資料品質監控運行結束後的 Hook 配置。 |
||
| Condition |
string |
否 |
Hook 觸發條件，當滿足這個條件時，會觸發 Hook 運行。目前只支援一種運算式寫法： 指定多組規則嚴重類型和規則校正狀態，如 |
results.any { r -> r.status == 'Fail' && r.rule.severity == 'Normal' || r.status == 'Error' && r.rule.severity == 'High' || r.status == 'Warn' && r.rule.severity == 'High' } |
| Type |
string |
否 |
Hook 類型。取值範圍：
|
BlockTaskInstance |
| Name |
string |
否 |
資料品質監控名稱。 |
data_quality_scan_001 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
22C97E95-F023-56B5-8852-B1A77A1**** |
| Success |
boolean |
調用是否成功。 |
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "22C97E95-F023-56B5-8852-B1A77A1****",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。