根據校正規則校正資料來源的品質，並查詢校正結果。
目前該API介面已標記為棄用，推薦使用替代API：dataworks-public(2024-05-18) - ListDataQualityScanRuns。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RuleId |
integer |
是 |
使用的校正規則 ID。您可以使用該規則 ID 與分區運算式等資訊進行聯集查詢。 |
152322134 |
| StartDate |
string |
是 |
業務日期起始時間，格式為 yyyy-MM-dd HH:mm:ss。 該參數與 EndDate 配合使用，二者所取的時間區間不能大於 7 天。 |
2020-09-20 00:00:00 |
| EndDate |
string |
是 |
業務日期截止時間，格式為 yyyy-MM-dd HH:mm:ss。 該參數與 StartDate 配合使用，二者所取的時間區間不能大於 7 天。 |
2020-09-22 00:00:00 |
| PageSize |
integer |
是 |
每頁顯示的條數，預設為 10 條，最大 20 條。 |
10 |
| PageNumber |
integer |
是 |
頁碼數。 |
1 |
| ProjectName |
string |
是 |
需要進行資料品質校正的引擎或者資料來源名稱。 |
autotest |
| ProjectId |
integer |
是 |
DataWorks 專案空間 ID。 |
123456 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
校正結果 |
||
| HttpStatusCode |
integer |
HTTP 狀態代碼。 |
200 |
| ErrorMessage |
string |
錯誤資訊。 |
You have no permission. |
| RequestId |
string |
請求 ID。 |
CBA58543-00D4-41**** |
| ErrorCode |
string |
錯誤碼。 |
401 |
| Success |
boolean |
請求是否成功。 |
true |
| Data |
object |
校正結果的頂層結構體。 |
|
| PageNumber |
integer |
頁碼數。 |
1 |
| PageSize |
integer |
每頁顯示的條數，預設為 10 條，最大 100 條。 |
10 |
| TotalCount |
integer |
資料的總記錄數。 |
200 |
| RuleChecks |
array<object> |
校正結果的列表。 |
|
|
array<object> |
校正結果 |
||
| BlockType |
integer |
校正規則的強弱。強弱表示規則的重要程度。取值如下：
|
1 |
| WarningThreshold |
number |
橙色閾值。表示與樣本預期的偏離程度，您可以根據業務需求自訂該閾值。 |
0.1 |
| Property |
string |
規則屬性的欄位，即被校正資料來源表的 column 名稱。 |
type |
| TableName |
string |
進行校正的表名稱。 |
dual |
| Comment |
string |
校正規則的描述。 |
The description of the rule. |
| CheckResultStatus |
integer |
校正結果狀態。 |
2 |
| TemplateName |
string |
使用的校正模板的名稱。 |
Expected value verification |
| CheckerName |
string |
校正器的名稱。 |
fulx |
| RuleId |
integer |
規則 ID。 |
123421 |
| FixedCheck |
boolean |
是否為固定值校正。取值如下：
|
false |
| Op |
string |
比較符。 |
> |
| UpperValue |
number |
預測上限。設定閾值後自動產生。 |
22200 |
| ActualExpression |
string |
被校正的資料來源表的實際分區。 |
ds=20200925 |
| ExternalId |
string |
調度任務的節點 ID。 |
123112232 |
| TimeCost |
string |
執行校正任務花費的時間。 |
10 |
| Trend |
string |
校正結果的趨勢。 |
up |
| ExternalType |
string |
調度系統的類型。目前僅支援 CWF。 |
CWF2 |
| BizDate |
integer |
業務日期。如果被校正的業務主體為離線資料，則業務日期通常為執行校正操作的前一天。 |
1600704000000 |
| CheckResult |
integer |
校正結果。 |
2 |
| ResultString |
string |
校正結果的字串形式。 |
ResultString |
| MatchExpression |
string |
分區運算式。 |
ds=$[yyyymmdd] |
| CheckerType |
integer |
校正器的類型。 |
0 |
| ProjectName |
string |
需要進行資料品質校正的引擎或者資料來源名稱。 |
autotest |
| BeginTime |
integer |
執行校正操作的開始時間。 |
1600704000000 |
| DateType |
string |
調度周期的類型。通常為 YMD，即年任務、月任務、天任務。 |
YMD |
| CriticalThreshold |
number |
紅色閾值。表示與樣本預期的偏離程度。您可以根據業務需求自訂該閾值。使用強規則並觸發紅色閾值，會阻塞調度任務。 |
0.6 |
| IsPrediction |
boolean |
是否為預測的結果。取值如下：
|
false |
| RuleName |
string |
規則的名稱。 |
The name of the rule. |
| CheckerId |
integer |
校正器的 ID。 |
7 |
| DiscreteCheck |
boolean |
是否為離散校正。取值如下：
|
true |
| EndTime |
integer |
查詢校正結果的截止時間。 |
1600704000000 |
| MethodName |
string |
採集樣本資料的方法。包括 avg、count、sum、min、max、count_distinct、user_defined、table_count、table_size、table_dt_load_count、table_dt_refuseload_count、null_value、null_value/table_count、(table_count-count_distinct)/table_count、table_count-count_distinct 等。 |
max |
| LowerValue |
number |
預測下限。根據您設定的閾值自動產生。 |
2344 |
| EntityId |
integer |
分區運算式 ID。 |
14534343 |
| WhereCondition |
string |
校正任務使用的過濾條件。 |
type!='type2' |
| ExpectValue |
number |
期望值。 |
90 |
| TemplateId |
integer |
使用的校正模板的 ID。 |
5 |
| TaskId |
string |
校正任務的 ID。 |
16008552981681a0d6**** |
| Id |
integer |
主鍵 ID。 |
2231123 |
| ReferenceValue |
array<object> |
歷史樣本值。 |
|
|
object |
校正結果 |
||
| DiscreteProperty |
string |
通過 group by 分組後的樣本欄位取值。例如 group by 性別欄位，則 DiscreteProperty 為男生、女生和 null。 |
type1 |
| Value |
number |
樣本值。 |
20 |
| BizDate |
string |
業務日期。如果被校正的業務主體為離線資料，則業務日期通常為執行校正操作的前一天。 |
1600704000000 |
| SingleCheckResult |
integer |
校正結果的字串。 |
2 |
| Threshold |
number |
閾值。 |
0.2 |
| SampleValue |
array<object> |
當前使用的樣本。 |
|
|
object |
校正結果 |
||
| DiscreteProperty |
string |
通過 group by 分組後的樣本欄位取值。例如 group by 性別欄位，則 DiscreteProperty 為男生、女生和 null。 |
type2 |
| BizDate |
string |
業務日期。如果被校正的業務主體為離線資料，則業務日期通常為執行校正操作的前一天。 |
1600704000000 |
| Value |
number |
樣本值。 |
23 |
| Open |
boolean |
規則是否開啟。 |
true |
樣本
正常返回樣本
JSON格式
{
"HttpStatusCode": 200,
"ErrorMessage": "You have no permission.",
"RequestId": "CBA58543-00D4-41****",
"ErrorCode": "401",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 200,
"RuleChecks": [
{
"BlockType": 1,
"WarningThreshold": 0.1,
"Property": "type",
"TableName": "dual",
"Comment": "The description of the rule.",
"CheckResultStatus": 2,
"TemplateName": "Expected value verification",
"CheckerName": "fulx",
"RuleId": 123421,
"FixedCheck": false,
"Op": ">",
"UpperValue": 22200,
"ActualExpression": "ds=20200925",
"ExternalId": "123112232",
"TimeCost": "10",
"Trend": "up",
"ExternalType": "CWF2",
"BizDate": 1600704000000,
"CheckResult": 2,
"ResultString": "ResultString",
"MatchExpression": "ds=$[yyyymmdd]",
"CheckerType": 0,
"ProjectName": "autotest",
"BeginTime": 1600704000000,
"DateType": "YMD",
"CriticalThreshold": 0.6,
"IsPrediction": false,
"RuleName": "The name of the rule.",
"CheckerId": 7,
"DiscreteCheck": true,
"EndTime": 1600704000000,
"MethodName": "max",
"LowerValue": 2344,
"EntityId": 14534343,
"WhereCondition": "type!='type2'",
"ExpectValue": 90,
"TemplateId": 5,
"TaskId": "16008552981681a0d6****",
"Id": 2231123,
"ReferenceValue": [
{
"DiscreteProperty": "type1",
"Value": 20,
"BizDate": "1600704000000",
"SingleCheckResult": 2,
"Threshold": 0.2
}
],
"SampleValue": [
{
"DiscreteProperty": "type2",
"BizDate": "1600704000000",
"Value": 23
}
],
"Open": true
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。