| object | | |
HttpStatusCode | integer | | 200 |
ErrorMessage | string | | You have no permission. |
RequestId | string | | CBA58543-00D4-41**** |
Success | boolean | Indicates whether the request was successful. | true |
ErrorCode | string | | 401 |
Data | object | The data structure of the check results. | |
PageNumber | integer | | 1 |
PageSize | integer | The number of entries per page. Default value: 10. Maximum value: 100. | 10 |
TotalCount | long | The total number of entries returned. | 50 |
RuleChecks | array<object> | The returned check results. | |
RuleChecks | object | The returned check result. | |
BlockType | integer | The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values: - 1: the monitoring rule is a strong rule.
- 0: the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.
| 0 |
WarningThreshold | float | The threshold for a warning alert. The threshold indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements. | 0.1 |
Property | string | The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored. | type |
TableName | string | The name of the table that is monitored. | dual |
CheckResultStatus | integer | The check result of the monitoring rule. Valid values: - 0: indicates that the data source table is normal.
- 1: indicates that a warning alert is reported.
- 2: indicates that a critical alert is reported.
| 0 |
TemplateName | string | The name of the monitoring template. | Expected value verification |
CheckerName | string | | fulx |
RuleId | integer | The ID of the monitoring rule. | 123123232 |
FixedCheck | boolean | Indicates whether the monitoring is performed based on a fixed value. Valid values: | false |
Op | string | | > |
UpperValue | float | The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify. | 25555 |
ActualExpression | string | The monitored partition in the data source table. | ds=20200912 |
ExternalId | string | | 1112323123 |
TimeCost | string | The time that was taken to run the monitoring task. Unit: seconds. | 202 |
Trend | string | The trend of the check result. | abs |
ExternalType | string | The type of the scheduling system. Only CWF scheduling systems are supported. | CWF2 |
BizDate | long | The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed. | 1600704000000 |
CheckResult | integer | The check result. The value of this parameter is the same as the value of the CheckResultStatus parameter. Valid values: - 0: indicates that the data source table is normal.
- 1: indicates that a warning alert is reported.
- 2: indicates that a critical alert is reported.
| 0 |
ResultString | string | The string of the check result. | test |
MatchExpression | string | The partition filter expression. | ds=$[yyyymmdd] |
CheckerType | integer | The check type. Valid values: - 0: indicates that the monitoring is performed based on a fixed value.
- 1: indicates that the monitoring is performed based on a non-fixed value.
- 2: indicates that the monitoring is performed based on a dynamic threshold.
| 1 |
ProjectName | string | The name of the compute engine or data source for which data quality is monitored. | autotest |
BeginTime | long | The time when the monitoring started. | 1600704000000 |
DateType | string | The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day. | YMD |
CriticalThreshold | float | The threshold for a critical alert. The threshold indicates the deviation of the check result from the expected value. You can specify a value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running. | 0.5 |
IsPrediction | boolean | Indicates whether the check result is the same as the predicted result. Valid values: | true |
RuleName | string | The name of the monitoring rule. | The name of the rule. |
CheckerId | integer | | 7 |
DiscreteCheck | boolean | Indicates whether the monitoring is discrete monitoring. Valid values: | true |
EndTime | long | The deadline for querying the check result. | 1600704000000 |
MethodName | string | The method used to collect sample data, such as such as 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, or table_count-count_distinct. | count_distinct |
LowerValue | float | The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify. | 2344 |
EntityId | integer | The ID of the partition filter expression. | 15432322 |
WhereCondition | string | The filter condition of the monitoring rule. | id>0 |
ExpectValue | float | | 200 |
TemplateId | integer | The ID of the monitoring template. | 5 |
TaskId | string | | 16008552981681a0d6**** |
Id | integer | | 121212121 |
ReferenceValue | array<object> | The historical sample values. | |
ReferenceValue | object | | |
DiscreteProperty | string | The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null. | 0 |
Value | float | | 19 |
BizDate | string | The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed. | 2020-12-03 |
SingleCheckResult | integer | | 0 |
Threshold | float | | 0.5 |
SampleValue | array<object> | The current sample value. | |
SampleValue | object | | |
DiscreteProperty | string | The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null. | 0 |
BizDate | string | The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed. | 2020-12-03 |
Value | float | The current sample value. | 19 |