调用ListQualityResultsByEntity,根据分区表达式查询历史校验结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
类型 |
是否必选 |
示例值 |
描述 |
|
Action | String | 是 | ListQualityResultsByEntity |
系统规定参数。取值:ListQualityResultsByEntity。 |
EntityId | Integer | 是 | 152322134 |
分区表达式ID。您可以调用GetQualityEntity获取分区表达式ID。 |
StartDate | String | 是 | 2020-09-20 00:00:00 |
业务日期起始时间,格式为yyyy-MM-dd HH:mm:ss。 |
EndDate | String | 是 | 2020-09-21 00:00:00 |
业务日期截止时间,格式为yyyy-MM-dd HH:mm:ss。 |
PageSize | Integer | 是 | 10 |
每页显示的条数,默认为10条,最大100条。 |
PageNumber | Integer | 是 | 1 |
页码数。 |
ProjectName | String | 是 | autotest |
引擎或者数据源的名称。您可以从数据源配置中获取名称。 |
ProjectId | Long | 否 | 12345 |
DataWorks项目空间ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
ErrorMessage | String | You have no permission. |
错误信息。 |
RequestId | String | CBA58543-00D4-41**** |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
ErrorCode | String | 401 |
错误码。 |
Data | Object |
校验结果的顶层结构体。 |
|
PageNumber | Integer | 1 |
页码数。 |
PageSize | Integer | 10 |
每页显示的条数,默认为10条,最大100条。 |
TotalCount | Long | 50 |
数据的总记录数。 |
RuleChecks | Array of RuleChecks |
校验结果的列表。 |
|
BlockType | Integer | 0 |
校验规则的强弱。强弱表示规则的重要程度。取值如下:
|
WarningThreshold | Float | 0.1 |
橙色阈值。表示与样本预期的偏离程度,您可以根据业务需求自定义该阈值。 |
Property | String | type |
规则属性的字段,即被校验数据源表的column名称。 |
TableName | String | dual |
进行校验的表名称。 |
Comment | String | 规则的描述信息。 |
校验规则的描述。 |
CheckResultStatus | Integer | 0 |
校验结果状态参数与产品界面中的状态信息一致,取值有以下几种:
|
TemplateName | String | 字段唯一值个数期望值校验 |
使用的校验模板的名称。 |
CheckerName | String | fulx |
校验器的名称。 |
RuleId | Integer | 123123232 |
规则ID。 |
FixedCheck | Boolean | false |
是否为固定值校验。取值如下:
|
Op | String | > |
比较符。 |
UpperValue | Float | 25555 |
预测上限。设置阈值后自动生成。 |
ActualExpression | String | ds=20200912 |
被校验的数据源表的实际分区。 |
ExternalId | String | 1112323123 |
调度任务的节点ID。 |
TimeCost | String | 202 |
执行校验任务花费的时间,单位为秒。 |
Trend | String | abs |
校验结果的趋势。 |
ExternalType | String | CWF2 |
调度系统的类型。目前仅支持CWF。 |
BizDate | Long | 1600704000000 |
业务日期。如果被校验的业务主体为离线数据,则业务日期通常为执行校验操作的前一天。 |
CheckResult | Integer | 0 |
校验结果参数的结果通常与CheckResultStatus一致,取值有以下几种:
|
ResultString | String | test |
校验结果的字符串形式。 |
MatchExpression | String | ds=$[yyyymmdd] |
分区表达式。 |
CheckerType | Integer | 1 |
校验类型。取值如下:
|
ProjectName | String | autotest |
需要进行数据质量校验的引擎或者数据源名称。 |
BeginTime | Long | 1600704000000 |
执行校验操作的开始时间。 |
DateType | String | YMD |
调度周期的类型。通常为YMD,即年任务、月任务、天任务。 |
CriticalThreshold | Float | 0.5 |
红色阈值。表示与样本预期的偏离程度。您可以根据业务需求自定义该阈值。使用强规则并触发红色阈值,会阻塞调度任务。 |
IsPrediction | Boolean | true |
是否为预测的结果。取值如下:
|
RuleName | String | 规则的名称。 |
规则的名称。 |
CheckerId | Integer | 7 |
校验器的ID。 |
DiscreteCheck | Boolean | true |
是否为离散校验。取值如下:
|
EndTime | Long | 1600704000000 |
查询校验结果的截止时间。 |
MethodName | String | count_distinct |
采集样本数据的方法。包括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等。 |
LowerValue | Float | 2344 |
预测结果的下限。根据您设置的阈值自动生成。 |
EntityId | Integer | 15432322 |
分区表达式ID。 |
WhereCondition | String | id>0 |
校验任务使用的规则过滤条件。 |
ExpectValue | Float | 200 |
期望值。 |
TemplateId | Integer | 5 |
使用的校验模板的ID。 |
TaskId | String | 16008552981681a0d6**** |
校验任务的ID。 |
Id | Integer | 121212121 |
主键ID。 |
ReferenceValue | Array of ReferenceValue |
历史样本值。 |
|
DiscreteProperty | String | 0 |
通过group by分组后的样本字段取值。例如group by性别字段,则DiscreteProperty为男生、女生和null。 |
Value | Float | 19 |
校验值。 |
BizDate | String | 2020-12-03 |
业务日期。如果被校验的业务主体为离线数据,则业务日期通常为执行校验操作的前一天。 |
SingleCheckResult | Integer | 0 |
校验结果。 |
Threshold | Float | 0.5 |
阈值。 |
SampleValue | Array of SampleValue |
当前使用的样本。 |
|
DiscreteProperty | String | 0 |
通过group by分组后的样本字段取值。例如group by性别字段,则DiscreteProperty为男生、女生和null。 |
BizDate | String | 2020-12-03 |
业务日期。如果被校验的业务主体为离线数据,则业务日期通常为执行校验操作的前一天。 |
Value | Float | 19 |
当前样本值。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListQualityResultsByEntity
&EntityId=152322134
&StartDate=2020-09-20 00:00:00
&EndDate=2020-09-21 00:00:00
&PageSize=10
&PageNumber=1
&ProjectName=autotest
&ProjectId=12345
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
200
You have no permission.
CBA58543-00D4-41****
true
401
1
10
50
0
0.1
type
dual
规则的描述信息。
0
字段唯一值个数期望值校验
fulx
123123232
false
>
25555
ds=20200912
1112323123
202
abs
CWF2
1600704000000
0
test
ds=$[yyyymmdd]
1
autotest
1600704000000
YMD
0.5
true
规则的名称。
7
true
1600704000000
count_distinct
2344
15432322
id>0
200
5
16008552981681a0d6****
121212121
0
19
2020-12-03
0
0.5
0
2020-12-03
19
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"ErrorMessage" : "You have no permission.",
"RequestId" : "CBA58543-00D4-41****",
"Success" : true,
"ErrorCode" : 401,
"Data" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 50,
"RuleChecks" : {
"BlockType" : 0,
"WarningThreshold" : 0.1,
"Property" : "type",
"TableName" : "dual",
"Comment" : "规则的描述信息。",
"CheckResultStatus" : 0,
"TemplateName" : "字段唯一值个数期望值校验",
"CheckerName" : "fulx",
"RuleId" : 123123232,
"FixedCheck" : false,
"Op" : ">",
"UpperValue" : 25555,
"ActualExpression" : "ds=20200912",
"ExternalId" : 1112323123,
"TimeCost" : 202,
"Trend" : "abs",
"ExternalType" : "CWF2",
"BizDate" : 1600704000000,
"CheckResult" : 0,
"ResultString" : "test",
"MatchExpression" : "ds=$[yyyymmdd]",
"CheckerType" : 1,
"ProjectName" : "autotest",
"BeginTime" : 1600704000000,
"DateType" : "YMD",
"CriticalThreshold" : 0.5,
"IsPrediction" : true,
"RuleName" : "规则的名称。",
"CheckerId" : 7,
"DiscreteCheck" : true,
"EndTime" : 1600704000000,
"MethodName" : "count_distinct",
"LowerValue" : 2344,
"EntityId" : 15432322,
"WhereCondition" : "id>0",
"ExpectValue" : 200,
"TemplateId" : 5,
"TaskId" : "16008552981681a0d6****",
"Id" : 121212121,
"ReferenceValue" : {
"DiscreteProperty" : 0,
"Value" : 19,
"BizDate" : "2020-12-03",
"SingleCheckResult" : 0,
"Threshold" : 0.5
},
"SampleValue" : {
"DiscreteProperty" : 0,
"BizDate" : "2020-12-03",
"Value" : 19
}
}
}
}
错误码
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/171191.html