查詢品質規則範本清單。
目前該API介面已標記為棄用，推薦使用替代API：dataworks-public(2024-05-18) - ListDataQualityTemplates。
介面說明
需要購買 DataWorks 基礎版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
是 |
DataWorks 工作空間 ID。 |
10000 |
| CreationSource |
string |
是 |
規則範本的建立來源，必填。取值：
|
System |
| DirectoryPath |
string |
否 |
自訂範本被存放的類目目錄，斜線 / 分隔層級。每個層級名稱最長 1024 個字元，不能包含空白字元、不能包含反斜線。 |
/ods/order_data |
| Name |
string |
否 |
範本規則名稱模糊比對，如果是系統範本，則會根據語言模糊比對系統範本的國際化名稱。 |
Table rows |
| PageNumber |
integer |
是 |
清單分頁查詢每頁筆數，預設為 10。 |
10 |
| PageSize |
integer |
是 |
清單分頁查詢頁碼，預設為 1。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
回傳值。 |
||
| RequestId |
string |
API 請求 ID。 |
691CA452-D37A-**** |
| PagingInfo |
object |
品質規則範本分頁查詢結果。 |
|
| TotalCount |
integer |
總筆數。 |
42 |
| PageSize |
integer |
每頁筆數。 |
10 |
| PageNumber |
integer |
頁碼。 |
1 |
| DataQualityRuleTemplates |
array<object> |
規則範本清單。 |
|
|
array<object> |
規則範本詳情。 |
||
| Code |
string |
規則範本 Code |
USER_DEFINED:123 |
| Name |
string |
規則範本名稱，數字、英文字母、漢字、半形全形標點符號組合，最長 512 個字元 |
Table row Count Verification |
| ProjectId |
integer |
DataWorks 工作空間 ID |
2043 |
| SamplingConfig |
object |
樣本採集所需的設定 |
|
| Metric |
string |
取樣的指標名稱
|
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 |
閾值計算方式
|
Fixed |
| ReferencedSamplesFilter |
string |
有些類型的閾值需要查詢出一些參考樣本，然後對參考樣本的值進行彙總得出進行比較的閾值，這裡使用一個表示式來表示參考樣本的查詢方式 |
{ "bizdate": [ "-1", "-7", "-1m" ] } |
| VisibleScope |
string |
範本的可用範圍：
|
Project |
| DirectoryPath |
string |
自訂範本被存放的類目目錄，斜線分隔層級。每個層級名稱最長 1024 個字元，不能包含空白字元、不能包含斜線 |
/ods/order_data |
樣本
正常返回樣本
JSON格式
{
"RequestId": "691CA452-D37A-****",
"PagingInfo": {
"TotalCount": 42,
"PageSize": 10,
"PageNumber": 1,
"DataQualityRuleTemplates": [
{
"Code": "USER_DEFINED:123",
"Name": "Table row Count Verification\n",
"ProjectId": 2043,
"SamplingConfig": {
"Metric": "Max",
"MetricParameters": "{\"Sql\": \"select count(1) from table;\"}\n",
"SettingConfig": "SET odps.sql.udf.timeout=600s; \nSET odps.sql.python.version=cp27;\n"
},
"CheckingConfig": {
"Type": "Fixed",
"ReferencedSamplesFilter": "{ \"bizdate\": [ \"-1\", \"-7\", \"-1m\" ] }\n"
},
"VisibleScope": "Project",
"DirectoryPath": "/ods/order_data"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。