Call the ListQualityResultsByEntity API to query historical data quality check results - DataWorks

Use ListQualityResultsByEntity to retrieve validation results based on a partition expression.

Note

This API has been deprecated. We recommend migrating to dataworks-public(2024-05-18) - ListDataQualityScanRuns for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
EntityId	integer	Yes	The ID of the partition expression. You can call the GetQualityEntity operation to obtain this ID.	15232
StartDate	string	Yes	The start of the business date range. The value must be in the `yyyy-MM-dd HH:mm:ss` format.	2020-09-20 00:00:00
EndDate	string	Yes	The end of the business date range. The value must be in the `yyyy-MM-dd HH:mm:ss` format.	2020-09-21 00:00:00
PageSize	integer	Yes	The number of entries to return per page. The default is 10, and the maximum is 20.	10
PageNumber	integer	Yes	The page number to return.	1
ProjectName	string	Yes	The name of the engine or data source. You can find this name on the Data Source Configuration page.	autotest
ProjectId	integer	Yes	The ID of the DataWorks workspace.	12345

Response elements

Element	Type	Description	Example
	object	The data quality check results.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	You have no permission.
RequestId	string	The ID of the request.	CBA58543-00D4-41****
Success	boolean	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	401
Data	object	The data object that contains the quality check results.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Default value: 10. Maximum value: 100.	10
TotalCount	integer	The total number of entries.	50
RuleChecks	array<object>	The monitoring rule check results.
	array<object>	The check result.
BlockType	integer	The strength of the monitoring rule. Valid values: 1: Strong Rule. If a Strong Rule check generates a critical alert, the associated Scheduling Task is blocked. 0: Weak Rule.	0
WarningThreshold	number	The warning threshold. This value indicates the acceptable deviation from the expected value. You can customize this threshold based on your business requirements.	0.1
Property	string	The name of the monitored column in the Data Source table.	type
TableName	string	The name of the table that is monitored.	dual
Comment	string	The description of the monitoring rule.	The description of the rule.
CheckResultStatus	integer	The status of the check result. This parameter corresponds to the status displayed in the UI. Valid values: 0: Normal 1: Warning 2: Critical	0
TemplateName	string	The name of the rule template.	Expected value verification
CheckerName	string	The name of the checker.	fulx
RuleId	integer	The monitoring rule ID.	123123232
FixedCheck	boolean	Specifies whether the check is based on a fixed value. Valid values: true: The check is based on a fixed value. false: The check is not based on a fixed value.	false
Op	string	The comparison operator.	>
UpperValue	number	The predicted upper limit. This value is automatically generated after you set a threshold.	25555
ActualExpression	string	The expression that specifies the data partition that was checked.	ds=20200912
ExternalId	string	The Node ID of the Scheduling Task.	1112323123
TimeCost	string	The time taken to run the check, in seconds.	202
Trend	string	The trend of the check result.	abs
ExternalType	string	The type of the scheduling system. Currently, only CWF is supported.	CWF2
BizDate	integer	The business date. If the monitored data is offline, the business date is typically the day before the check is performed.	1600704000000
CheckResult	integer	The check result. This parameter usually has the same value as `CheckResultStatus`. Valid values: 0: Normal 1: Warning 2: Critical	0
ResultString	string	The check result, returned as a string.	test
MatchExpression	string	The partition filter expression.	ds=$[yyyymmdd]
CheckerType	integer	The type of the checker. Valid values: 0: Fixed Value 1: Fluctuation 2: Dynamic Threshold	1
ProjectName	string	The name of the monitored compute engine or Data Source.	autotest
BeginTime	integer	The start time of the check. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1600704000000
DateType	string	The scheduling cycle. A common value is YMD, which represents year, month, and day.	YMD
CriticalThreshold	number	The acceptable deviation from the expected value that triggers a critical alert. This threshold is customizable. If a critical alert is triggered for a Strong Rule, the associated Scheduling Task is blocked.	0.5
IsPrediction	boolean	Specifies whether the result is a predicted value. Valid values: true: The result is a predicted value. false: The result is not a predicted value.	true
RuleName	string	The name of the monitoring rule.	The name of the rule.
CheckerId	integer	The ID of the checker.	7
DiscreteCheck	boolean	Specifies whether the check is a discrete check. Valid values: true: The check is a discrete check. false: The check is not a discrete check.	true
EndTime	integer	The end time of the check. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1600704000000
MethodName	string	The method for collecting sample data. Valid values include `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`, and `table_count-count_distinct`.	count_distinct
LowerValue	number	The predicted lower limit. This value is automatically generated after you set a threshold.	2344
EntityId	integer	The ID of the partition filter expression.	15432322
WhereCondition	string	The filter condition of the monitoring rule.	id>0
ExpectValue	number	The expected value.	200
TemplateId	integer	The ID of the rule template.	5
TaskId	string	The ID of the check task.	16008552981681a0d6****
Id	integer	The unique ID of the check result.	121212121
ReferenceValue	array<object>	The historical sample values.
	object	A historical check result.
DiscreteProperty	string	The value of the sample field when a `group by` clause is used. For example, if you group by the gender field, the values for `DiscreteProperty` can be male, female, or null.	0
Value	number	The historical check value.	19
BizDate	string	The business date. If the monitored data is offline, the business date is typically the day before the check is performed.	2020-12-03
SingleCheckResult	integer	The result of a single check.	0
Threshold	number	The threshold that was applied to this historical data point.	0.5
SampleValue	array<object>	The current sample values.
	object	A sample check result.
DiscreteProperty	string	The value of the sample field when a `group by` clause is used. For example, if you group by the gender field, the values for `DiscreteProperty` can be male, female, or null.	0
BizDate	string	The business date. If the monitored data is offline, the business date is typically the day before the check is performed.	2020-12-03
Value	number	The current sample value.	19

Examples

Success response

JSON format

{
  "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": "The description of the rule.",
        "CheckResultStatus": 0,
        "TemplateName": "Expected value verification",
        "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": "The name of the rule.",
        "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
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.