Queries the monitoring result history based on a partition filter expression.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListQualityResultsByEntity |
The operation that you want to perform. |
EndDate | String | Yes | 2020-09-21 00:00:00 |
The end time of the query. The time is in the yyyy-MM-dd HH:mm:ss format. |
EntityId | Integer | Yes | 152322134 |
The ID of the partition filter expression. |
PageNumber | Integer | Yes | 1 |
The page number of the returned page. |
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. |
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 ID of the instance. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
QualityResults | Struct |
The top-level structure of the verification result. |
|
PageNumber | Integer | 1 |
The page number of the returned page. |
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=20200912 |
The actual partition. |
BeginTime | Long | 1600704000000 |
Verification start time. |
BizDate | Long | 1600704000000 |
The data timestamp. |
BlockType | Integer | 0 |
Rule strength:
|
CheckResult | Integer | 0 |
Verification result:
|
CheckResultStatus | Integer | 0 |
The verification result, which is the same as that provided by checkresult. |
CheckerId | Integer | 7 |
The ID of the Checker. |
CheckerName | String | fulx |
The name of the Checker. |
CheckerType | Integer | 0 |
The verification type. |
Comment | String | Description of the test rule |
The description of the event rule. |
CriticalThreshold | Float | 0.5 |
The warning threshold. |
DateType | String | YMD |
The task time type. |
DiscreteCheck | Boolean | true |
Indicates whether the checksum is discrete. |
EndTime | Long | 1600704000000 |
The end time of the checksum verification. |
EntityId | Integer | 15432322 |
The ID of the partition filter expression. |
ExpectValue | Float | 200 |
The expected value of the checker. |
ExternalId | String | 1112323123 |
Identification ID of the external trigger system. |
ExternalType | String | CWF2 |
The trigger type of an external system. |
FixedCheck | Boolean | false |
Indicates whether to static field verification. |
Id | Integer | 121212121 |
The ID of the internal primary key. |
IsPrediction | Boolean | true |
Indicates whether the prediction is successful. |
LowerValue | Float | 232222 |
The lower limit of prediction results. |
MatchExpression | String | ds=$[yyyymmdd] |
The partition expression. |
MethodName | String | count_distinct |
The name of the collection method. |
Op | String | > |
The comparison symbol. |
ProjectName | String | autotest |
The name of the database engine or data source. |
Property | String | type |
The field of the rule attribute. |
ReferenceValue | Array of ReferenceValue |
History sample value. |
|
BizDate | String | 2020-12-03 |
The data timestamp, in the yyyy-MM-dd format. |
DiscreteProperty | String | 0 |
Unique Values |
SingleCheckResult | Integer | 0 |
Verification result |
Threshold | Float | 0.5 |
Value |
Value | Float | 19 |
Check value |
ResultString | String | test |
The verification result must be in character format. |
RuleId | Integer | 123123232 |
The ID of the rule. |
RuleName | String | Test scripts. |
The name of the rule. |
SampleValue | Array of SampleValue |
Current sample. |
|
BizDate | String | 2020-12-03 |
The data timestamp. |
DiscreteProperty | String | 0 |
Unique value. |
Value | Float | 19 |
Current 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 | 202s |
Verification duration |
Trend | String | abs |
The trend of the expected value. |
UpperValue | Float | 25555 |
The upper limit of prediction results. |
WarningThreshold | Float | 0.1 |
The warning threshold. |
WhereCondition | String | id>0 |
The rule filter condition. |
TotalCount | Long | 50 |
The total number of alert events. |
RequestId | String | CBA58543-00D4-41**** |
The ID of the request. |
Examples
Sample request
http(s)://[Endpoint]/? Action=ListQualityResultsByEntity &EndDate=2020-09-21 00:00:00 &EntityId=152322134 &PageNumber=1 &PageSize=10 &ProjectName=autotest &StartDate=2020-09-20 00:00:00 &<common request parameters>
Sample success responses
XML
format
<RequestId> CBA58543-00D4-41**** </RequestId> <QualityResults> <TotalCount> 50 </TotalCount> <PageSize> 10 </PageSize> <PageNumber> 1 </PageNumber> <RuleChecks> <Op> > </Op> <TaskId> 16008552981681a0d6**** </TaskId> <EndTime> 1600704000000 </EndTime> <DiscreteCheck> true </DiscreteCheck> <CheckerName> fulx </CheckerName> <ExpectValue> 200 </ExpectValue> <ProjectName> autotest </ProjectName> <RuleId> 123123232 </RuleId> <WarningThreshold> 0.1 </WarningThreshold> <WhereCondition> id>0 </WhereCondition> <BeginTime> 1600704000000 </BeginTime> <CheckResultStatus> 0 </CheckResultStatus> <MatchExpression> ds=$[yyyymmdd] </MatchExpression> <UpperValue> 25555 </UpperValue> <IsPrediction> true </IsPrediction> <CheckResult> 0 </CheckResult> <TemplateName> field unique value number expectations OSS checks the received data against the </TemplateName> <TimeCost> 202s </TimeCost> <FixedCheck> false </FixedCheck> <MethodName> count_distinct </MethodName> <ResultString> test </ResultString> <Property> type </Property> <DateType> YMD </DateType> <BizDate> 1600704000000 </BizDate> <TemplateId> 5 </TemplateId> <RuleName> test rules </RuleName> description of <Comment> test rules </Comment> <CriticalThreshold> 0.5 </CriticalThreshold> <ExternalId> 1112323123 </ExternalId> <Trend> abs </Trend> <CheckerType> 0 </CheckerType> <ExternalType> CWF2 </ExternalType> <CheckerId> 7 </CheckerId> <EntityId> 15432322 </EntityId> <TableName> dual </TableName> <BlockType> 0 </BlockType> <Id> 121212121 </Id> <ActualExpression> ds=20200912 </ActualExpression> <LowerValue> 232222 </LowerValue> </RuleChecks> <RuleChecks> <SampleValue> <SingleCheckResult> 0 </SingleCheckResult> <Value> 19 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> 0 </DiscreteProperty> <Threshold> 0.5 </Threshold> </SampleValue> <SampleValue> <Value> 19 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> 0 </DiscreteProperty> </SampleValue> <ReferenceValue> <SingleCheckResult> 0 </SingleCheckResult> <Value> 19 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> 0 </DiscreteProperty> <Threshold> 0.5 </Threshold> </ReferenceValue> <ReferenceValue> <Value> 19 </Value> <BizDate> 1600704000000 </BizDate> <DiscreteProperty> 0 </DiscreteProperty> </ReferenceValue> </RuleChecks> </QualityResults>
JSON
{"RequestId": "CBA58543-00D4-41****", "QualityResults": { "TotalCount": 50, "PageSize": 10, "PageNumber": 1, "RuleChecks": [ { "Op": ">", "TaskId": "16008552981681a0d6****", "EndTime": 1600704000000, "DiscreteCheck": true, "CheckerName": "fulx"," ExpectValue": 200, "ProjectName": "autotest", "RuleId": 123123232, "WarningThreshold": 0.1, "WhereCondition": "id>0", "BeginTime": 1600704000000, "CheckResultStatus": 0, "MatchExpression": "ds=$[yyyymmdd]", "UpperValue": 25555, "IsPrediction": true, "CheckResult": 0, "TemplateName": "Verification of the number of expected unique values in a field", "TimeCost": "202s", "FixedCheck": false, "MethodName": "count_distinct", "ResultString": "test", "Property": "type", "DateType": "YMD", "BizDate": 1600704000000, "TemplateId": 5, "RuleName": "Test rule", "Comment": "description of the test rule", "CriticalThreshold": 0.5, "ExternalId": 1112323123, "Trend": "abs", "CheckerType": 0, "ExternalType": "CWF2", "CheckerId": 7, "EntityId": 15432322, "TableName": "dual", "BlockType": 0, "Id": 121212121, "ActualExpression": "ds=20200912"," LowerValue": 232222 }, { "SampleValue": [ { "SingleCheckResult": 0, "Value": 19, "BizDate": 1600704000000, "DiscreteProperty": 0, "Threshold": 0.5 }, { "Value": 19, "BizDate": 1600704000000, "DiscreteProperty": 0 } ], "ReferenceValue": [ {"SingleCheckResult": 0, "Value": 19, "BizDate": 1600704000000, "DiscreteProperty": 0, "Threshold": 0.5 }, { "Value": 19, "BizDate": 1600704000000, "DiscreteProperty": 0 } ] } ] } }
Error codes
For more information about error codes, see error center.