根據校驗規則校驗數據源的質量,并查詢校驗結果。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RuleId | long | 是 | 使用的校驗規則 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 | long | 是 | DataWorks 項目空間 ID。 | 12345 |
返回參數
示例
正常返回示例
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": "規則的描述信息。",
"CheckResultStatus": 2,
"TemplateName": "字段唯一值個數期望值校驗",
"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": "規則的名稱。",
"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
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-10 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-03-08 | OpenAPI 入參發生變更 | 查看變更詳情 |