Queries the monitoring result history based on a monitoring rule.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListQualityResultsByRule |
The operation that you want to perform. |
EndDate | String | Yes | 2020-09-22 00:00:00 |
The end time of the query. The time is in the yyyy-MM-dd HH:mm:ss format. |
PageNumber | Integer | Yes | 1 |
The page that is returned. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
ProjectName | String | Yes | autotest |
The name of the database engine or data source. |
RuleId | Integer | Yes | 152322134 |
The ID of the rule. |
StartDate | String | Yes | 2020-09-20 00:00:00 |
The beginning of the time range that you want to query. The time is in the yyyy-MM-dd HH:mm:ss format. |
RegionId | String | No | cn-hangzhou |
The region information. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
QualityResults | Struct |
The top-level structure of the verification result. |
|
PageNumber | Integer | 1 |
The page that is returned. |
PageSize | Integer | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
RuleChecks | Array of RuleChecks |
The list of verification results. |
|
ActualExpression | String | ds=20200925 |
The actual partition. |
BeginTime | Long | 1600704000000 |
The start time of the checksum. |
BizDate | Long | 1600704000000 |
The business date of the school inspection. |
BlockType | Integer | 1 |
Rule strength. |
CheckResult | Integer | 2 |
The verification result. |
CheckResultStatus | Integer | 2 |
The verification result. |
CheckerId | Integer | 7 |
The ID of the Checker. |
CheckerName | String | fulx |
The name of the Checker. |
CheckerType | Integer | 0 |
The type of checker. |
Comment | String | This is the rule description. |
The description of the event rule. |
CriticalThreshold | Float | 0.6 |
The error threshold. |
DateType | String | YMD |
Type of date. |
DiscreteCheck | Boolean | true |
Indicates whether the checksum is discrete. |
EndTime | Long | 1600704000000 |
The end of the time range to query. |
EntityId | Integer | 14534343 |
The ID of the partition filter expression. |
ExpectValue | Float | 90 |
The expected value of the checker. |
ExternalId | String | 123112232 |
The ID triggered by the external system. |
ExternalType | String | CWF2 |
Type of external system. |
FixedCheck | Boolean | false |
Indicates whether to static field verification. |
Id | Integer | 2231123 |
The ID of the primary key. |
IsPrediction | Boolean | false |
Indicates whether the prediction is successful. |
LowerValue | Float | 2344 |
Forecast lower limit. |
MatchExpression | String | ds=$[yyyymmdd] |
The partition expression. |
MethodName | String | max |
Collection method. |
Op | String | > |
The comparison operator. |
ProjectName | String | autotest |
Name of the engine and data source. |
Property | String | type |
The field of the rule attribute. |
ReferenceValue | Array of ReferenceValue |
History sample value. |
|
BizDate | Long | 1600704000000 |
The data timestamp of the node instance. |
DiscreteProperty | String | type1 |
Discrete unique value. |
SingleCheckResult | Integer | 2 |
The verification result. |
Threshold | Float | 0.2 |
The trend of the expected value. |
Value | Float | 20 |
Sample value. |
ResultString | String | ResultString |
The verification result in string format. |
RuleId | Integer | 123421 |
The ID of the rule. |
RuleName | String | Here is the rule name. |
The name of the rule. |
SampleValue | Array of SampleValue |
Current sample. |
|
BizDate | Long | 1600704000000 |
The data timestamp of the node instance. |
DiscreteProperty | String | type2 |
Discrete attribute. |
Value | Float | 23 |
Sample value. |
TableName | String | dual |
The name of the table. |
TaskId | String | 16008552981681a0d6**** |
The ID of the task. |
TemplateId | Integer | 5 |
The ID of the launch template. |
TemplateName | String | Check the desired number of unique values of fields |
The name of the parameter template. |
TimeCost | String | 10 |
The time spent on the verification. |
Trend | String | up |
The trend of the expected value. |
UpperValue | Float | 22200 |
The upper limit of the prediction. |
WarningThreshold | Float | 0.1 |
The warning threshold. |
WhereCondition | String | type! ='type2' |
The filter condition. |
TotalCount | Long | 200 |
The total number of data records. |
RequestId | String | CBA58543-00D4-41**** |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListQualityResultsByRule &EndDate=2020-09-22 00:00:00 &PageNumber=1 &PageSize=10 &ProjectName=autotest &RuleId=152322134 &StartDate=2020-09-20 00:00:00 &<common request parameters>
Sample success responses
XML
format
<RequestId>CBA58543-00D4-41****</RequestId> <QualityResults> <TotalCount>200</TotalCount> <PageSize>10</PageSize> <PageNumber>1</PageNumber> <RuleChecks> <Op>></Op> <TaskId>16008552981681a0d6****</TaskId> <EndTime>1600704000000</EndTime> <DiscreteCheck>true</DiscreteCheck> <CheckerName>fulx</CheckerName> <ExpectValue>90</ExpectValue> <ProjectName>autotest</ProjectName> <RuleId>123421</RuleId> <WarningThreshold>0.1</WarningThreshold> <WhereCondition>type! ='type2' </WhereCondition> <BeginTime> 1600704000000 </BeginTime> <CheckResultStatus> 2 </CheckResultStatus> <MatchExpression> ds=$[yyyymmdd] </MatchExpression> <UpperValue> 22200 </UpperValue> <IsPrediction> false </IsPrediction> <CheckResult> 2 </CheckResult> <TemplateName> field unique value number expectations OSS checks the received data against the </TemplateName> <TimeCost> 10 </TimeCost> <FixedCheck> false </FixedCheck> <MethodName> max </MethodName> <ResultString> ResultString </ResultString> <Property> type </Property> <DateType> YMD </DateType> <BizDate> 1600704000000 </BizDate> <TemplateId> 5 </TemplateId> <RuleName> this is the rule name </RuleName>. <Comment> here is the rule description information </Comment> <CriticalThreshold> 0.6 </CriticalThreshold> <ExternalId> 123112232 </ExternalId> <Trend> up </Trend> <CheckerType> 0 </CheckerType> <ExternalType> CWF2 </ExternalType> <CheckerId> 7 </CheckerId> <EntityId> 14534343 </EntityId> <TableName> dual </TableName> <BlockType> 1 </BlockType> <Id> 2231123 </Id> <ActualExpression> ds=20200925 </ActualExpression> <LowerValue> 2344 </LowerValue> </RuleChecks> <RuleChecks> <SampleValue> <SingleCheckResult> 2 </SingleCheckResult> <Value> 20 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> type1 </DiscreteProperty> <Threshold> 0.2 </Threshold> </SampleValue> <SampleValue> <Value> 23 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> type2 </DiscreteProperty> </SampleValue> <ReferenceValue> <SingleCheckResult> 2 </SingleCheckResult> <Value> 20 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> type1 </DiscreteProperty> <Threshold> 0.2 </Threshold> </ReferenceValue> <ReferenceValue> <Value> 23 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> type2 </DiscreteProperty> </ReferenceValue> </RuleChecks> </QualityResults>
JSON
Hint
{ "RequestId": "CBA58543-00D4-41****", "QualityResults": { "TotalCount": 200, "PageSize": 10, "PageNumber": 1, "RuleChecks": [ { "Op": ">", "TaskId": "16008552981681a0d6****", "EndTime": 1600704000000, "DiscreteCheck": true, "CheckerName": "fulx", "ExpectValue": 90, "ProjectName": "autotest", "RuleId": 123421, "WarningThreshold": 0.1, "WhereCondition": "type! ='type2' ", " BeginTime ": 1600704000000," CheckResultStatus ": 2, " MatchExpression ": " ds=$[yyyymmdd]", " UpperValue ": 22200, " IsPrediction ": false, " CheckResult ": 2, " TemplateName ": " The number of unique field values and expected values ", " TimeCost ": 10, " FixedCheck ": false, " MethodName ": " max ", " ResultString ": " ResultString ", " Property ": " type ", " DateType ": " YMD ", " BizDate ": 1600704000000," TemplateId ": 5, " RuleName ": " The rule name ", " Comment ": " The rule Description ", " CriticalThreshold ": 0.6, " ExternalId ": 123112232, " Trend ": " up ", " CheckerType ": 0, " ExternalType ": "CWF2", "CheckerId": 7, "EntityId": 14534343, "TableName": "dual", "BlockType": 1, "Id": 2231123, "ActualExpression": "ds=20200925", "LowerValue": 2344 }, { "SampleValue": [ { "SingleCheckResult": 2, "Value": 20, "BizDate": 1600704000000, "DiscreteProperty": "type1", "Threshold": 0.2 }, { "Value": 23, "BizDate": 1600704000000, "DiscreteProperty": "type2" } ], "ReferenceValue": [ { "SingleCheckResult": 2, "Value": 20, "BizDate": 1600704000000, "DiscreteProperty": "type1", "Threshold": 0.2 }, { "Value": 23, "BizDate": 1600704000000, "DiscreteProperty": "type2" } ] } ] } }
Error code
Go to the Error CenterFor more information, see error codes.